Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLINFO_COOKIELIST (3)

Name

CURLINFO_COOKIELIST - get all known cookies

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_COOKIELIST,
struct curl_slist **cookies);

Description

CURLINFO_COOKIELIST(3)     curl_easy_getinfo options    CURLINFO_COOKIELIST(3)



NAME
       CURLINFO_COOKIELIST - get all known cookies

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_COOKIELIST,
                                  struct curl_slist **cookies);

DESCRIPTION
       Pass  a  pointer to a 'struct curl_slist *' to receive a linked-list of
       all cookies curl knows  (expired  ones,  too).  Don't  forget  to  call
       curl_slist_free_all(3)  on  the  list after it has been used.  If there
       are no cookies (cookies for the handle have not been enabled or  simply
       none  have been received) 'struct curl_slist *' will be set to point to
       NULL.

       Since 7.43.0 cookies that were imported in the Set-Cookie format  with-
       out a domain name are not exported by this option.

PROTOCOLS
       HTTP(S)

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

         /* enable the cookie engine with a non-existing file */
         curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "-");

         res = curl_easy_perform(curl);

         if(!res) {
           /* extract all known cookies */
           struct curl_slist *cookies = NULL;
           res = curl_easy_getinfo(curl, CURLINFO_COOKIELIST, &cookies);
           if(!res && cookies) {
             /* a linked list of cookies in cookie file format */
             struct curl_slist *each = cookies;
             while(each) {
               printf("%s", each->data);
               each = each->next;
             }
             /* we must free these cookies when we're done */
             curl_slist_free_all(cookies);
           }
         }
         curl_easy_cleanup(curl);
       }

AVAILABILITY
       Added in 7.14.1

RETURN VALUE
       Returns  CURLE_OK  if the option is supported, and CURLE_UNKNOWN_OPTION
       if not.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       curl_easy_getinfo(3), curl_easy_setopt(3), CURLOPT_COOKIELIST(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

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



libcurl 7.44.0                    1 Sep 2015            CURLINFO_COOKIELIST(3)