blob: df5773c548ee5890d4cbb3a83fa7478dce684955 [file] [log] [blame]
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Elliott Hughes82be86d2017-09-20 17:00:17 -07008.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07009.\" *
10.\" * This software is licensed as described in the file COPYING, which
11.\" * you should have received as part of this distribution. The terms
Alex Deymo8f1a2142016-06-28 14:49:26 -070012.\" * are also available at https://curl.haxx.se/docs/copyright.html.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070013.\" *
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.\"
Elliott Hughescac39802018-04-27 16:19:43 -070023.TH CURLOPT_FILETIME 3 "April 03, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
Elliott Hughes82be86d2017-09-20 17:00:17 -070024
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070025.SH NAME
26CURLOPT_FILETIME \- get the modification time of the remote resource
27.SH SYNOPSIS
28#include <curl/curl.h>
29
30CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FILETIME, long gettime);
31.SH DESCRIPTION
32Pass a long. If it is 1, libcurl will attempt to get the modification time of
33the remote document in this operation. This requires that the remote server
34sends the time or replies to a time querying command. The
Alex Deymo8f1a2142016-06-28 14:49:26 -070035\fIcurl_easy_getinfo(3)\fP function with the \fICURLINFO_FILETIME(3)\fP
36argument can be used after a transfer to extract the received time (if any).
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070037.SH DEFAULT
380
39.SH PROTOCOLS
40HTTP, FTP, SFTP, FILE
41.SH EXAMPLE
Elliott Hughes82be86d2017-09-20 17:00:17 -070042.nf
43curl = curl_easy_init();
44if(curl) {
45 curl_easy_setopt(curl, CURLOPT_URL, url);
46 /* Ask for filetime */
47 curl_easy_setopt(curl, CURLOPT_FILETIME, 1L);
48 res = curl_easy_perform(curl);
49 if(CURLE_OK == res) {
50 res = curl_easy_getinfo(curl, CURLINFO_FILETIME, &filetime);
51 if((CURLE_OK == res) && (filetime >= 0)) {
52 time_t file_time = (time_t)filetime;
53 printf("filetime %s: %s", filename, ctime(&file_time));
54 }
55 }
56 /* always cleanup */
57 curl_easy_cleanup(curl);
58}
59.fi
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070060.SH AVAILABILITY
Alex Deymo8f1a2142016-06-28 14:49:26 -070061Always, for SFTP since 7.49.0
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070062.SH RETURN VALUE
63Returns CURLE_OK
64.SH "SEE ALSO"
65.BR curl_easy_getinfo "(3), "