2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-11-20 05:30:11 -07:00
repo/core/curl/files/CURLOPT_TIMECONDITION.3

52 lines
1.5 KiB
Groff
Raw Normal View History

.\" generated by cd2nroff 0.1 from CURLOPT_TIMECONDITION.md
2024-03-30 12:28:04 -06:00
.TH CURLOPT_TIMECONDITION 3 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
2024-03-30 12:28:04 -06:00
HTTP
.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
Always
.SH RETURN VALUE
Returns CURLE_OK
.SH SEE ALSO
.BR CURLINFO_FILETIME (3),
.BR CURLOPT_TIMEVALUE (3)