CURLOPT_TIMEVALUE.3 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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 CURLOPT_TIMEVALUE 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_TIMEVALUE \- time value for conditional
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEVALUE, long val);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a long \fIval\fP as parameter. This should be the time counted as seconds
  33. since 1 Jan 1970, and the time will be used in a condition as specified with
  34. \fICURLOPT_TIMECONDITION(3)\fP.
  35. On systems with 32 bit 'long' variables, this option cannot set dates beyond
  36. the year 2038. Consider \fICURLOPT_TIMEVALUE_LARGE(3)\fP instead.
  37. .SH DEFAULT
  38. 0
  39. .SH PROTOCOLS
  40. HTTP, FTP, RTSP, and FILE
  41. .SH EXAMPLE
  42. .nf
  43. CURL *curl = curl_easy_init();
  44. if(curl) {
  45. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  46. /* January 1, 2020 is 1577833200 */
  47. curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);
  48. /* If-Modified-Since the above time stamp */
  49. curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);
  50. /* Perform the request */
  51. curl_easy_perform(curl);
  52. }
  53. .fi
  54. .SH AVAILABILITY
  55. Always
  56. .SH RETURN VALUE
  57. Returns CURLE_OK
  58. .SH "SEE ALSO"
  59. .BR CURLOPT_TIMECONDITION "(3), "