docs/libcurl/opts/CURLINFO_FILETIME.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24 .SH NAME
  25 CURLINFO_FILETIME \- get the remote time of the retrieved document
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_FILETIME, long *timep);
  30 .SH DESCRIPTION
  31 Pass a pointer to a long to receive the remote time of the retrieved document
  32 (in number of seconds since 1 jan 1970 in the GMT/UTC time zone). If you get
  33 -1, it can be because of many reasons (it might be unknown, the server might
  34 hide it or the server doesn't support the command that tells document time
  35 etc) and the time of the document is unknown.
  36
  37 Note that you must tell the server to collect this information before the
  38 transfer is made, by using the \fICURLOPT_FILETIME(3)\fP option to
  39 \fIcurl_easy_setopt(3)\fP or you will unconditionally get a -1 back.
  40 .SH PROTOCOLS
  41 HTTP(S), FTP(S)
  42 .SH EXAMPLE
  43 TODO
  44 .SH AVAILABILITY
  45 Added in 7.5
  46 .SH RETURN VALUE
  47 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  48 .SH "SEE ALSO"
  49 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "