CURLINFO_CONDITION_UNMET.3 2.6 KB

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