CURLINFO_FILETIME_T.3 2.8 KB

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