Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_FILETIME_T.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2018, 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 CURLINFO_FILETIME 3 "January 25, 2018" "libcurl 7.70.0" "curl_easy_getinfo options"
! 24:
! 25: .SH NAME
! 26: CURLINFO_FILETIME_T \- get the remote time of the retrieved document
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FILETIME_T, curl_off_t *timep);
! 31: .SH DESCRIPTION
! 32: Pass a pointer to a curl_off_t to receive the remote time of the retrieved
! 33: document (in number of seconds since 1 jan 1970 in the GMT/UTC time zone). If
! 34: you get -1, it can be because of many reasons (it might be unknown, the server
! 35: might hide it or the server doesn't support the command that tells document
! 36: time etc) and the time of the document is unknown.
! 37:
! 38: You must ask libcurl to collect this information before the transfer is made,
! 39: by using the \fICURLOPT_FILETIME(3)\fP option to \fIcurl_easy_setopt(3)\fP or
! 40: you will unconditionally get a -1 back.
! 41:
! 42: This option is an alternative to \fICURLINFO_FILETIME(3)\fP to allow systems
! 43: with 32 bit long variables to extract dates outside of the 32bit timestamp
! 44: range.
! 45: .SH PROTOCOLS
! 46: HTTP(S), FTP(S), SFTP
! 47: .SH EXAMPLE
! 48: .nf
! 49: curl = curl_easy_init();
! 50: if(curl) {
! 51: curl_easy_setopt(curl, CURLOPT_URL, url);
! 52: /* Ask for filetime */
! 53: curl_easy_setopt(curl, CURLOPT_FILETIME, 1L);
! 54: res = curl_easy_perform(curl);
! 55: if(CURLE_OK == res) {
! 56: curl_off_t filetime;
! 57: res = curl_easy_getinfo(curl, CURLINFO_FILETIME_T, &filetime);
! 58: if((CURLE_OK == res) && (filetime >= 0)) {
! 59: time_t file_time = (time_t)filetime;
! 60: printf("filetime %s: %s", filename, ctime(&file_time));
! 61: }
! 62: }
! 63: /* always cleanup */
! 64: curl_easy_cleanup(curl);
! 65: }
! 66: .fi
! 67: .SH AVAILABILITY
! 68: Added in 7.59.0
! 69: .SH RETURN VALUE
! 70: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
! 71: .SH "SEE ALSO"
! 72: .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>