xref: /aosp_15_r20/external/curl/docs/libcurl/opts/CURLOPT_TIMEVALUE.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: CURLOPT_TIMEVALUE
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_TIMECONDITION (3)
9*6236dae4SAndroid Build Coastguard Worker  - CURLOPT_TIMEVALUE_LARGE (3)
10*6236dae4SAndroid Build Coastguard WorkerProtocol:
11*6236dae4SAndroid Build Coastguard Worker  - HTTP
12*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.1
13*6236dae4SAndroid Build Coastguard Worker---
14*6236dae4SAndroid Build Coastguard Worker
15*6236dae4SAndroid Build Coastguard Worker# NAME
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard WorkerCURLOPT_TIMEVALUE - time value for conditional
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker~~~c
22*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
23*6236dae4SAndroid Build Coastguard Worker
24*6236dae4SAndroid Build Coastguard WorkerCURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEVALUE, long val);
25*6236dae4SAndroid Build Coastguard Worker~~~
26*6236dae4SAndroid Build Coastguard Worker
27*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard WorkerPass a long *val* as parameter. This should be the time counted as seconds
30*6236dae4SAndroid Build Coastguard Workersince 1 Jan 1970, and the time is used in a condition as specified with
31*6236dae4SAndroid Build Coastguard WorkerCURLOPT_TIMECONDITION(3).
32*6236dae4SAndroid Build Coastguard Worker
33*6236dae4SAndroid Build Coastguard WorkerOn systems with 32-bit 'long' variables (such as Windows), this option cannot
34*6236dae4SAndroid Build Coastguard Workerset dates beyond the year 2038. Consider CURLOPT_TIMEVALUE_LARGE(3)
35*6236dae4SAndroid Build Coastguard Workerinstead.
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard Worker# DEFAULT
38*6236dae4SAndroid Build Coastguard Worker
39*6236dae4SAndroid Build Coastguard Worker0
40*6236dae4SAndroid Build Coastguard Worker
41*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
42*6236dae4SAndroid Build Coastguard Worker
43*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
44*6236dae4SAndroid Build Coastguard Worker
45*6236dae4SAndroid Build Coastguard Worker~~~c
46*6236dae4SAndroid Build Coastguard Workerint main(void)
47*6236dae4SAndroid Build Coastguard Worker{
48*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
49*6236dae4SAndroid Build Coastguard Worker  if(curl) {
50*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
51*6236dae4SAndroid Build Coastguard Worker
52*6236dae4SAndroid Build Coastguard Worker    /* January 1, 2020 is 1577833200 */
53*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);
54*6236dae4SAndroid Build Coastguard Worker
55*6236dae4SAndroid Build Coastguard Worker    /* If-Modified-Since the above time stamp */
56*6236dae4SAndroid Build Coastguard Worker    curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
57*6236dae4SAndroid Build Coastguard Worker
58*6236dae4SAndroid Build Coastguard Worker    /* Perform the request */
59*6236dae4SAndroid Build Coastguard Worker    curl_easy_perform(curl);
60*6236dae4SAndroid Build Coastguard Worker  }
61*6236dae4SAndroid Build Coastguard Worker}
62*6236dae4SAndroid Build Coastguard Worker~~~
63*6236dae4SAndroid Build Coastguard Worker
64*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
65*6236dae4SAndroid Build Coastguard Worker
66*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
67*6236dae4SAndroid Build Coastguard Worker
68*6236dae4SAndroid Build Coastguard WorkerReturns CURLE_OK
69