Return to CURLINFO_CONDITION_UNMET.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_CONDITION_UNMET.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2020, 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 "April 04, 2020" "libcurl 7.70.0" "curl_easy_getinfo options"
                     24: 
                     25: .SH NAME
                     26: CURLINFO_CONDITION_UNMET \- get info on unmet time conditional or 304 HTTP response.
                     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. This can also return 1 if
                     37: the server responded with a 304 HTTP status code, for example after sending a
                     38: custom "If-Match-*" header.
                     39: .SH PROTOCOLS
                     40: HTTP and some
                     41: .SH EXAMPLE
                     42: .nf
                     43: CURL *curl = curl_easy_init();
                     44: if(curl) {
                     45:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
                     46: 
                     47:   /* January 1, 2020 is 1577833200 */
                     48:   curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);
                     49: 
                     50:   /* If-Modified-Since the above time stamp */
                     51:   curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
                     52: 
                     53:   /* Perform the request */
                     54:   res = curl_easy_perform(curl);
                     55: 
                     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), "