Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLINFO_FILETIME_T (3)

Name

CURLINFO_FILETIME_T - get the remote time of the retrieved document

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FILETIME_T,
curl_off_t *timep);

Description

CURLINFO_FILETIME(3)       curl_easy_getinfo options      CURLINFO_FILETIME(3)



NAME
       CURLINFO_FILETIME_T - get the remote time of the retrieved document

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FILETIME_T,
                                  curl_off_t *timep);

DESCRIPTION
       Pass  a  pointer  to  a  curl_off_t  to  receive the remote time of the
       retrieved document (in number of  seconds  since  1  jan  1970  in  the
       GMT/UTC  time  zone).  If you get -1, it can be because of many reasons
       (it might be unknown, the server might hide it or the server  does  not
       support  the  command that tells document time etc) and the time of the
       document is unknown.

       You must ask libcurl to collect this information before the transfer is
       made, by using the CURLOPT_FILETIME(3) option to curl_easy_setopt(3) or
       you will unconditionally get a -1 back.

       This option is an alternative to CURLINFO_FILETIME(3) to allow  systems
       with  32 bit long variables to extract dates outside of the 32bit time-
       stamp range.

PROTOCOLS
       HTTP(S), FTP(S), SFTP

EXAMPLE
       curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, url);
         /* Ask for filetime */
         curl_easy_setopt(curl, CURLOPT_FILETIME, 1L);
         res = curl_easy_perform(curl);
         if(CURLE_OK == res) {
           curl_off_t filetime;
           res = curl_easy_getinfo(curl, CURLINFO_FILETIME_T, &filetime);
           if((CURLE_OK == res) && (filetime >= 0)) {
             time_t file_time = (time_t)filetime;
             printf("filetime %s: %s", filename, ctime(&file_time));
           }
         }
         /* always cleanup */
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.59.0

RETURN VALUE
       Returns CURLE_OK if the option is supported,  and  CURLE_UNKNOWN_OPTION
       if not.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       curl_easy_getinfo(3), curl_easy_setopt(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021          CURLINFO_FILETIME(3)