tizen 2.3.1 release
[external/curl.git] / docs / libcurl / opts / CURLOPT_FILETIME.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.
13 .\" *
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 .\"
23 .TH CURLOPT_FILETIME 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_FILETIME \- get the modification time of the remote resource
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FILETIME, long gettime);
30 .SH DESCRIPTION
31 Pass a long. If it is 1, libcurl will attempt to get the modification time of
32 the remote document in this operation. This requires that the remote server
33 sends the time or replies to a time querying command. The
34 \fIcurl_easy_getinfo(3)\fP function with the \fICURLINFO_FILETIME\fP argument
35 can be used after a transfer to extract the received time (if any).
36 .SH DEFAULT
37 0
38 .SH PROTOCOLS
39 HTTP, FTP, SFTP, FILE
40 .SH EXAMPLE
41 TODO
42 .SH AVAILABILITY
43 Always
44 .SH RETURN VALUE
45 Returns CURLE_OK
46 .SH "SEE ALSO"
47 .BR curl_easy_getinfo "(3), "