2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-12-24 00:10:05 -07:00
repo/core/curl/files/CURLOPT_TIMEVALUE.3
2024-07-29 19:00:04 -05:00

49 lines
1.3 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_TIMEVALUE.md
.TH CURLOPT_TIMEVALUE 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_TIMEVALUE \- time value for conditional
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEVALUE, long val);
.fi
.SH DESCRIPTION
Pass a long \fIval\fP as parameter. This should be the time counted as seconds
since 1 Jan 1970, and the time is used in a condition as specified with
\fICURLOPT_TIMECONDITION(3)\fP.
On systems with 32\-bit \(aqlong\(aq variables (such as Windows), this option cannot
set dates beyond the year 2038. Consider \fICURLOPT_TIMEVALUE_LARGE(3)\fP
instead.
.SH DEFAULT
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, 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 CURLOPT_TIMECONDITION (3),
.BR CURLOPT_TIMEVALUE_LARGE (3)