xref: /curl/docs/libcurl/opts/CURLINFO_FILETIME.md (revision e3fe0200)
1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLINFO_FILETIME
5Section: 3
6Source: libcurl
7See-also:
8  - CURLOPT_FILETIME (3)
9  - curl_easy_getinfo (3)
10  - curl_easy_setopt (3)
11Protocol:
12  - HTTP
13  - FTP
14  - SFTP
15---
16
17# NAME
18
19CURLINFO_FILETIME - get the remote time of the retrieved document
20
21# SYNOPSIS
22
23~~~c
24#include <curl/curl.h>
25
26CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FILETIME, long *timep);
27~~~
28
29# DESCRIPTION
30
31Pass a pointer to a long to receive the remote time of the retrieved document
32in number of seconds since January 1 1970 in the GMT/UTC time zone. If you get
33-1, it can be because of many reasons (it might be unknown, the server might
34hide it or the server does not support the command that tells document time
35etc) and the time of the document is unknown.
36
37You must tell libcurl to collect this information before the transfer is made,
38by using the CURLOPT_FILETIME(3) option to curl_easy_setopt(3) or
39you this unconditionally gets a -1 back.
40
41Consider using CURLINFO_FILETIME_T(3) to be able to extract dates beyond
42the year 2038 on systems using 32 bit longs (Windows).
43
44# EXAMPLE
45
46~~~c
47int main(void)
48{
49  CURL *curl = curl_easy_init();
50  if(curl) {
51    CURLcode res;
52    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
53    /* Ask for filetime */
54    curl_easy_setopt(curl, CURLOPT_FILETIME, 1L);
55    res = curl_easy_perform(curl);
56    if(CURLE_OK == res) {
57      long filetime = 0;
58      res = curl_easy_getinfo(curl, CURLINFO_FILETIME, &filetime);
59      if((CURLE_OK == res) && (filetime >= 0)) {
60        time_t file_time = (time_t)filetime;
61        printf("filetime: %s", ctime(&file_time));
62      }
63    }
64    /* always cleanup */
65    curl_easy_cleanup(curl);
66  }
67}
68~~~
69
70# AVAILABILITY
71
72Added in 7.5
73
74# RETURN VALUE
75
76Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
77