| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 |
- .\" generated by cd2nroff 0.1 from CURLOPT_TIMECONDITION.md
- .TH CURLOPT_TIMECONDITION 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_TIMECONDITION \- select condition for a time request
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMECONDITION, long cond);
- .fi
- .SH DESCRIPTION
- Pass a long as parameter. This defines how the \fICURLOPT_TIMEVALUE(3)\fP time
- value is treated. You can set this parameter to \fICURL_TIMECOND_IFMODSINCE\fP
- or \fICURL_TIMECOND_IFUNMODSINCE\fP.
- 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. \fIcurl_easy_getinfo(3)\fP with the \fICURLINFO_CONDITION_UNMET\fP
- option can be used after a transfer to learn if a zero\-byte successful
- \&"transfer" was due to this condition not matching.
- .SH DEFAULT
- CURL_TIMECOND_NONE (0)
- .SH PROTOCOLS
- This functionality affects http only
- .SH EXAMPLE
- .nf
- 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,
- (long)CURL_TIMECOND_IFMODSINCE);
- /* Perform the request */
- curl_easy_perform(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.1
- .SH RETURN VALUE
- Returns CURLE_OK
- .SH SEE ALSO
- .BR CURLINFO_FILETIME (3),
- .BR CURLOPT_TIMEVALUE (3)
|