e694c8284a
Expand a little. - mention the type name of the return code - avoid stating which exact return codes that might be returned, as that varies over time, builds and conditions - avoid stating some always return OK - refer to the manpage documenting all the return codes Closes #15900
81 lines
2.0 KiB
Markdown
81 lines
2.0 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLINFO_FILETIME_T
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_FILETIME (3)
|
|
- curl_easy_getinfo (3)
|
|
- curl_easy_setopt (3)
|
|
Protocol:
|
|
- HTTP
|
|
- FTP
|
|
- SFTP
|
|
Added-in: 7.59.0
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLINFO_FILETIME_T - get the remote time of the retrieved document
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#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 January 1 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 or you 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 32-bit timestamp range.
|
|
|
|
# %PROTOCOLS%
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
/* 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", ctime(&file_time));
|
|
}
|
|
}
|
|
/* always cleanup */
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# %AVAILABILITY%
|
|
|
|
# RETURN VALUE
|
|
|
|
curl_easy_getinfo(3) returns a CURLcode indicating success or error.
|
|
|
|
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
|
|
libcurl-errors(3).
|