Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_COOKIESESSION (3)

Name

CURLOPT_COOKIESESSION - start a new cookie session

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIESESSION, long init);

Description

CURLOPT_COOKIESESSION(3)   curl_easy_setopt options   CURLOPT_COOKIESESSION(3)



NAME
       CURLOPT_COOKIESESSION - start a new cookie session

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIESESSION, long init);

DESCRIPTION
       Pass  a  long  set to 1 to mark this as a new cookie "session". It will
       force libcurl to ignore all cookies it is about to load that are  "ses-
       sion  cookies"  from  the  previous session. By default, libcurl always
       stores and loads all cookies, independent if they are  session  cookies
       or  not.  Session  cookies are cookies without expiry date and they are
       meant to be alive and existing for this "session" only.

       A "session" is usually defined in browser land for as long as you  have
       your browser up, more or less.

DEFAULT
       0

PROTOCOLS
       HTTP

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

         /* new "session", do not load session cookies */
         curl_easy_setopt(curl, CURLOPT_COOKIESESSION, 1L);

         /* get the (non session) cookies from this file */
         curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "/tmp/cookies.txt");

         ret = curl_easy_perform(curl);

         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Along with HTTP

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_COOKIEFILE(3), CURLOPT_COOKIE(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_COOKIESESSION(3)