CURLOPT_TIMEVALUE.3 2.2 KB

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