docs/libcurl/opts/CURLINFO_CONDITION_UNMET.3

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