CURLINFO_CONDITION_UNMET.3 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" **************************************************************************
  22. .\"
  23. .TH CURLINFO_CONDITION_UNMET 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_CONDITION_UNMET \- get info on unmet time conditional or 304 HTTP response.
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONDITION_UNMET,
  30. long *unmet);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a pointer to a long to receive the number 1 if the condition provided in
  34. the previous request did not match (see \fICURLOPT_TIMECONDITION(3)\fP). Alas,
  35. if this returns a 1 you know that the reason you did not get data in return is
  36. because it did not fulfill the condition. The long this argument points to will
  37. get a zero stored if the condition instead was met. This can also return 1 if
  38. the server responded with a 304 HTTP status code, for example after sending a
  39. custom "If-Match-*" header.
  40. .SH PROTOCOLS
  41. HTTP and some
  42. .SH EXAMPLE
  43. .nf
  44. CURL *curl = curl_easy_init();
  45. if(curl) {
  46. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  47. /* January 1, 2020 is 1577833200 */
  48. curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);
  49. /* If-Modified-Since the above time stamp */
  50. curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
  51. /* Perform the request */
  52. res = curl_easy_perform(curl);
  53. if(!res) {
  54. /* check the time condition */
  55. long unmet;
  56. res = curl_easy_getinfo(curl, CURLINFO_CONDITION_UNMET, &unmet);
  57. if(!res) {
  58. printf("The time condition was %sfulfilled\\n", unmet?"NOT":"");
  59. }
  60. }
  61. }
  62. .fi
  63. .SH AVAILABILITY
  64. Added in 7.19.4
  65. .SH RETURN VALUE
  66. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  67. .SH "SEE ALSO"
  68. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "