CURLINFO_CONDITION_UNMET.3 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLINFO_CONDITION_UNMET 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_getinfo options"
  26. .SH NAME
  27. CURLINFO_CONDITION_UNMET \- get info on unmet time conditional or 304 HTTP response.
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONDITION_UNMET,
  32. long *unmet);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a pointer to a long to receive the number 1 if the condition provided in
  36. the previous request did not match (see \fICURLOPT_TIMECONDITION(3)\fP). Alas,
  37. if this returns a 1 you know that the reason you did not get data in return is
  38. because it did not fulfill the condition. The long this argument points to will
  39. get a zero stored if the condition instead was met. This can also return 1 if
  40. the server responded with a 304 HTTP status code, for example after sending a
  41. custom "If-Match-*" header.
  42. .SH PROTOCOLS
  43. HTTP and some
  44. .SH EXAMPLE
  45. .nf
  46. CURL *curl = curl_easy_init();
  47. if(curl) {
  48. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  49. /* January 1, 2020 is 1577833200 */
  50. curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);
  51. /* If-Modified-Since the above time stamp */
  52. curl_easy_setopt(curl, CURLOPT_TIMECONDITION,
  53. (long)CURL_TIMECOND_IFMODSINCE);
  54. /* Perform the request */
  55. res = curl_easy_perform(curl);
  56. if(!res) {
  57. /* check the time condition */
  58. long unmet;
  59. res = curl_easy_getinfo(curl, CURLINFO_CONDITION_UNMET, &unmet);
  60. if(!res) {
  61. printf("The time condition was %sfulfilled\\n", unmet?"NOT":"");
  62. }
  63. }
  64. }
  65. .fi
  66. .SH AVAILABILITY
  67. Added in 7.19.4
  68. .SH RETURN VALUE
  69. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  70. .SH "SEE ALSO"
  71. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "