Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_FILETIME.3, revision 1.1.1.1

1.1       misho       1: .\" **************************************************************************
                      2: .\" *                                  _   _ ____  _
                      3: .\" *  Project                     ___| | | |  _ \| |
                      4: .\" *                             / __| | | | |_) | |
                      5: .\" *                            | (__| |_| |  _ <| |___
                      6: .\" *                             \___|\___/|_| \_\_____|
                      7: .\" *
                      8: .\" * Copyright (C) 1998 - 2017, 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 https://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 "April 03, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_FILETIME \- get the modification time of the remote resource
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FILETIME, long gettime);
                     31: .SH DESCRIPTION
                     32: Pass a long. If it is 1, libcurl will attempt to get the modification time of
                     33: the remote document in this operation. This requires that the remote server
                     34: sends the time or replies to a time querying command. The
                     35: \fIcurl_easy_getinfo(3)\fP function with the \fICURLINFO_FILETIME(3)\fP
                     36: argument can be used after a transfer to extract the received time (if any).
                     37: .SH DEFAULT
                     38: 0
                     39: .SH PROTOCOLS
                     40: HTTP, FTP, SFTP, FILE
                     41: .SH EXAMPLE
                     42: .nf
                     43: curl = curl_easy_init();
                     44: if(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
                     60: .SH AVAILABILITY
                     61: Always, for SFTP since 7.49.0
                     62: .SH RETURN VALUE
                     63: Returns CURLE_OK
                     64: .SH "SEE ALSO"
                     65: .BR curl_easy_getinfo "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>