Return to CURLINFO_FILETIME.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_FILETIME.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 CURLINFO_FILETIME 3 "January 25, 2018" "libcurl 7.70.0" "curl_easy_getinfo options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLINFO_FILETIME \- get the remote time of the retrieved document
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FILETIME, long *timep);
        !            31: .SH DESCRIPTION
        !            32: Pass a pointer to a long to receive the remote time of the retrieved document
        !            33: (in number of seconds since 1 jan 1970 in the GMT/UTC time zone). If you get
        !            34: -1, it can be because of many reasons (it might be unknown, the server might
        !            35: hide it or the server doesn't support the command that tells document time
        !            36: etc) and the time of the document is unknown.
        !            37: 
        !            38: You must tell libcurl to collect this information before the transfer is made,
        !            39: by using the \fICURLOPT_FILETIME(3)\fP option to \fIcurl_easy_setopt(3)\fP or
        !            40: you will unconditionally get a -1 back.
        !            41: 
        !            42: Consider using \fICURLINFO_FILETIME_T(3)\fP to be able to extract dates beyond
        !            43: the year 2038 on systems using 32 bit longs.
        !            44: .SH PROTOCOLS
        !            45: HTTP(S), FTP(S), SFTP
        !            46: .SH EXAMPLE
        !            47: .nf
        !            48: curl = curl_easy_init();
        !            49: if(curl) {
        !            50:   curl_easy_setopt(curl, CURLOPT_URL, url);
        !            51:   /* Ask for filetime */
        !            52:   curl_easy_setopt(curl, CURLOPT_FILETIME, 1L);
        !            53:   res = curl_easy_perform(curl);
        !            54:   if(CURLE_OK == res) {
        !            55:     res = curl_easy_getinfo(curl, CURLINFO_FILETIME, &filetime);
        !            56:     if((CURLE_OK == res) && (filetime >= 0)) {
        !            57:       time_t file_time = (time_t)filetime;
        !            58:       printf("filetime %s: %s", filename, ctime(&file_time));
        !            59:     }
        !            60:   }
        !            61:   /* always cleanup */
        !            62:   curl_easy_cleanup(curl);
        !            63: }
        !            64: .fi
        !            65: .SH AVAILABILITY
        !            66: Added in 7.5
        !            67: .SH RETURN VALUE
        !            68: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            69: .SH "SEE ALSO"
        !            70: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "