Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TIMEVALUE_LARGE.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
! 9: .\" *
! 10: .\" * This software is licensed as described in the file COPYING, which
! 11: .\" * you should have received as part of this distribution. The terms
! 12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
! 13: .\" *
! 14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
! 15: .\" * copies of the Software, and permit persons to whom the Software is
! 16: .\" * furnished to do so, under the terms of the COPYING file.
! 17: .\" *
! 18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
! 19: .\" * KIND, either express or implied.
! 20: .\" *
! 21: .\" **************************************************************************
! 22: .\"
! 23: .TH CURLOPT_TIMEVALUE_LARGE 3 "January 25, 2018" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_TIMEVALUE_LARGE \- set time value for conditional
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEVALUE_LARGE, curl_off_t val);
! 31: .SH DESCRIPTION
! 32: Pass a curl_off_t \fIval\fP as parameter. This should be the time counted as
! 33: seconds since 1 Jan 1970, and the time will be used in a condition as
! 34: specified with \fICURLOPT_TIMECONDITION(3)\fP.
! 35:
! 36: The difference between this option and \fICURLOPT_TIMEVALUE(3)\fP is the type
! 37: of the argument. On systems where 'long' is only 32 bit wide, this option has
! 38: to be used to set dates beyond the year 2038.
! 39: .SH DEFAULT
! 40: 0
! 41: .SH PROTOCOLS
! 42: HTTP, FTP, RTSP, and FILE
! 43: .SH EXAMPLE
! 44: .nf
! 45: CURL *curl = curl_easy_init();
! 46: if(curl) {
! 47: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
! 48:
! 49: /* January 1, 2020 is 1577833200 */
! 50: curl_easy_setopt(curl, CURLOPT_TIMEVALUE_LARGE, (curl_off_t)1577833200);
! 51:
! 52: /* If-Modified-Since the above time stamp */
! 53: curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
! 54:
! 55: /* Perform the request */
! 56: curl_easy_perform(curl);
! 57: }
! 58: .fi
! 59: .SH AVAILABILITY
! 60: Added in 7.59.0.
! 61: .SH RETURN VALUE
! 62: Returns CURLE_OK
! 63: .SH "SEE ALSO"
! 64: .BR CURLOPT_TIMECONDITION "(3), "
! 65: .BR CURLOPT_TIMEVALUE_LARGE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>