Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_CONDITION_UNMET.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, 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 "1 Sep 2015" "libcurl 7.44.0" "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
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONDITION_UNMET, long *unmet);
30 .SH DESCRIPTION
31 Pass a pointer to a long to receive the number 1 if the condition provided in
32 the previous request didn't match (see \fICURLOPT_TIMECONDITION(3)\fP). Alas,
33 if this returns a 1 you know that the reason you didn't get data in return is
34 because it didn't fulfill the condition. The long ths argument points to will
35 get a zero stored if the condition instead was met.
36 .SH PROTOCOLS
37 HTTP and some
38 .SH EXAMPLE
39 TODO
40 .SH AVAILABILITY
41 Added in 7.19.4
42 .SH RETURN VALUE
43 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
44 .SH "SEE ALSO"
45 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "