mirror of
https://github.com/curl/curl.git
synced 2026-07-01 05:49:08 +03:00
d01d2ec9f1
Some CURLOPT constants defined in the curl public headers were initially enums (= ints), or macros with bare numeric values. Recent curl releases upgraded them to `long` constants, to make them pass correctly to `curl_easy_setop()` by default, i.e. without requiring a `(long)` cast. This patch drops such casts from the examples embedded in the docs. At the same time it documents which curl release made them `long` types, to keep them useful when working with previous libcurl versions. Also: - drop a `(long)` cast that was never necessary. - CURLOPT_ALTSVC_CTRL.md: bump local copy of macros to long. - test1119: make it ignore symbols ending with an underscore, to skip wildcard, e.g. `**CURLAUTH_***`. Closes #18130
78 lines
1.8 KiB
Markdown
78 lines
1.8 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_TIMECONDITION
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLINFO_FILETIME (3)
|
|
- CURLOPT_TIMEVALUE (3)
|
|
Protocol:
|
|
- HTTP
|
|
Added-in: 7.1
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_TIMECONDITION - select condition for a time request
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMECONDITION, long cond);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a long as parameter. This defines how the CURLOPT_TIMEVALUE(3) time
|
|
value is treated. You can set this parameter to *CURL_TIMECOND_IFMODSINCE*
|
|
or *CURL_TIMECOND_IFUNMODSINCE*.
|
|
|
|
The last modification time of a file is not always known and in such instances
|
|
this feature has no effect even if the given time condition would not have
|
|
been met. curl_easy_getinfo(3) with the *CURLINFO_CONDITION_UNMET*
|
|
option can be used after a transfer to learn if a zero-byte successful
|
|
"transfer" was due to this condition not matching.
|
|
|
|
# DEFAULT
|
|
|
|
CURL_TIMECOND_NONE (0)
|
|
|
|
# %PROTOCOLS%
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
/* January 1, 2020 is 1577833200 */
|
|
curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);
|
|
|
|
/* If-Modified-Since the above time stamp */
|
|
curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
|
|
|
|
/* Perform the request */
|
|
curl_easy_perform(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# HISTORY
|
|
|
|
**CURL_TIMECOND_*** enums became `long` types in 8.13.0, prior to this version
|
|
a `long` cast was necessary when passed to curl_easy_setopt(3).
|
|
|
|
# %AVAILABILITY%
|
|
|
|
# RETURN VALUE
|
|
|
|
curl_easy_setopt(3) returns a CURLcode indicating success or error.
|
|
|
|
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
|
|
libcurl-errors(3).
|