CURLOPT_TIMEVALUE_LARGE.3 2.4 KB

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