69 lines
2.2 KiB
Groff
69 lines
2.2 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" * SPDX-License-Identifier: curl
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_TIMEVALUE 3 "17 Jun 2014" libcurl 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 'long' 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
|
|
HTTP, FTP, RTSP, and FILE
|
|
.SH EXAMPLE
|
|
.nf
|
|
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
|
|
Always
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_TIMECONDITION (3),
|
|
.BR CURLOPT_TIMEVALUE_LARGE (3)
|