Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TIMEVALUE.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 3 "January 25, 2018" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_TIMEVALUE \- set time value for conditional
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEVALUE, long val);
        !            31: .SH DESCRIPTION
        !            32: Pass a long \fIval\fP as parameter. This should be the time counted as seconds
        !            33: since 1 Jan 1970, and the time will be used in a condition as specified with
        !            34: \fICURLOPT_TIMECONDITION(3)\fP.
        !            35: 
        !            36: On systems with 32 bit 'long' variables, this option cannot set dates beyond
        !            37: the year 2038. Consider \fICURLOPT_TIMEVALUE_LARGE(3)\fP instead.
        !            38: .SH DEFAULT
        !            39: 0
        !            40: .SH PROTOCOLS
        !            41: HTTP, FTP, RTSP, and FILE
        !            42: .SH EXAMPLE
        !            43: .nf
        !            44: CURL *curl = curl_easy_init();
        !            45: if(curl) {
        !            46:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
        !            47: 
        !            48:   /* January 1, 2020 is 1577833200 */
        !            49:   curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);
        !            50: 
        !            51:   /* If-Modified-Since the above time stamp */
        !            52:   curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
        !            53: 
        !            54:   /* Perform the request */
        !            55:   curl_easy_perform(curl);
        !            56: }
        !            57: .fi
        !            58: .SH AVAILABILITY
        !            59: Always
        !            60: .SH RETURN VALUE
        !            61: Returns CURLE_OK
        !            62: .SH "SEE ALSO"
        !            63: .BR CURLOPT_TIMECONDITION "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>