aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_TIMEVALUE.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_TIMEVALUE.md')
-rw-r--r--docs/libcurl/opts/CURLOPT_TIMEVALUE.md69
1 files changed, 69 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_TIMEVALUE.md b/docs/libcurl/opts/CURLOPT_TIMEVALUE.md
new file mode 100644
index 000000000..cc8f6032c
--- /dev/null
+++ b/docs/libcurl/opts/CURLOPT_TIMEVALUE.md
@@ -0,0 +1,69 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLOPT_TIMEVALUE
+Section: 3
+Source: libcurl
+See-also:
+ - CURLOPT_TIMECONDITION (3)
+ - CURLOPT_TIMEVALUE_LARGE (3)
+---
+
+# NAME
+
+CURLOPT_TIMEVALUE - time value for conditional
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEVALUE, long val);
+~~~
+
+# DESCRIPTION
+
+Pass a long *val* 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
+CURLOPT_TIMECONDITION(3).
+
+On systems with 32 bit 'long' variables (such as Windows), this option cannot
+set dates beyond the year 2038. Consider CURLOPT_TIMEVALUE_LARGE(3)
+instead.
+
+# DEFAULT
+
+0
+
+# PROTOCOLS
+
+HTTP, FTP, RTSP, and FILE
+
+# EXAMPLE
+
+~~~c
+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);
+ }
+}
+~~~
+
+# AVAILABILITY
+
+Always
+
+# RETURN VALUE
+
+Returns CURLE_OK