repo/core/curl/files/CURLOPT_FILETIME.3

.\" generated by cd2nroff 0.1 from CURLOPT_FILETIME.md
.TH CURLOPT_FILETIME 3 "2024-11-09" libcurl
.SH NAME
CURLOPT_FILETIME \- get the modification time of the remote resource
.SH SYNOPSIS
.nf
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FILETIME, long gettime);
.fi
.SH DESCRIPTION
Pass a long. If it is 1, libcurl attempts to get the modification time of the
remote document in this operation. This requires that the remote server sends
the time or replies to a time querying command. The \fIcurl_easy_getinfo(3)\fP
function with the \fICURLINFO_FILETIME(3)\fP argument can be used after a
transfer to extract the received time (if any).
.SH DEFAULT
0
.SH PROTOCOLS
This functionality affects file, ftp, http, sftp and smb
.SH EXAMPLE
.nf
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/path.html");
    /* Ask for filetime */
    curl_easy_setopt(curl, CURLOPT_FILETIME, 1L);
    res = curl_easy_perform(curl);
    if(CURLE_OK == res) {
      long filetime;
      res = curl_easy_getinfo(curl, CURLINFO_FILETIME, &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);
  }
}
.fi
.SH AVAILABILITY
Added in curl 7.5
.SH RETURN VALUE
Returns CURLE_OK
.SH SEE ALSO
.BR CURLINFO_FILETIME (3),
.BR curl_easy_getinfo (3)