Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_TIMECONDITION (3)

Name

CURLOPT_TIMECONDITION - select condition for a time request

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMECONDITION, long cond);

Description

CURLOPT_TIMECONDITION(3)   curl_easy_setopt options   CURLOPT_TIMECONDITION(3)



NAME
       CURLOPT_TIMECONDITION - select condition for a time request

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMECONDITION, long cond);

DESCRIPTION
       Pass  a  long  as  parameter. This defines how the CURLOPT_TIMEVALUE(3)
       time value is  treated.  You  can  set  this  parameter  to  CURL_TIME-
       COND_IFMODSINCE or CURL_TIMECOND_IFUNMODSINCE.

       The  last  modification  time of a file is not always known and in such
       instances this feature will have no effect even if the given time  con-
       dition   would   not  have  been  met.  curl_easy_getinfo(3)  with  the
       CURLINFO_CONDITION_UNMET option can be used after a transfer  to  learn
       if  a  zero-byte  successful  "transfer"  was due to this condition not
       matching.

DEFAULT
       CURL_TIMECOND_NONE (0)

PROTOCOLS
       HTTP, FTP, RTSP, and FILE

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

         /* January 1, 2020 is 1577833200 */
         curl_easy_setopt(curl, CURLOPT_TIMEVALUE, 1577833200L);

         /* If-Modified-Since the above time stamp */
         curl_easy_setopt(curl, CURLOPT_TIMECONDITION, CURL_TIMECOND_IFMODSINCE);

         /* Perform the request */
         curl_easy_perform(curl);
       }

AVAILABILITY
       Always

RETURN VALUE
       Returns CURLE_OK


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_TIMEVALUE(3),



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source      was      downloaded       from        https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021      CURLOPT_TIMECONDITION(3)