| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <[email protected]>, 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 CURLINFO_COOKIELIST 3 "1 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options" |
| 24 |
.SH NAME |
| 25 |
CURLINFO_COOKIELIST \- get all known cookies |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_COOKIELIST, |
| 30 |
struct curl_slist **cookies); |
| 31 |
.SH DESCRIPTION |
| 32 |
Pass a pointer to a 'struct curl_slist *' to receive a linked-list of all |
| 33 |
cookies curl knows (expired ones, too). Don't forget to call |
| 34 |
\fIcurl_slist_free_all(3)\fP on the list after it has been used. If there are |
| 35 |
no cookies (cookies for the handle have not been enabled or simply none have |
| 36 |
been received) 'struct curl_slist *' will be set to point to NULL. |
| 37 |
|
| 38 |
Since 7.43.0 cookies that were imported in the Set-Cookie format without a |
| 39 |
domain name are not exported by this option. |
| 40 |
.SH PROTOCOLS |
| 41 |
HTTP(S) |
| 42 |
.SH EXAMPLE |
| 43 |
.nf |
| 44 |
CURL *curl = curl_easy_init(); |
| 45 |
if(curl) { |
| 46 |
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); |
| 47 |
|
| 48 |
/* enable the cookie engine */ |
| 49 |
curl_easy_setopt(curl, CURLOPT_COOKIEFILE, ""); |
| 50 |
|
| 51 |
res = curl_easy_perform(curl); |
| 52 |
|
| 53 |
if(!res) { |
| 54 |
/* extract all known cookies */ |
| 55 |
struct curl_slist *cookies = NULL; |
| 56 |
res = curl_easy_getinfo(curl, CURLINFO_COOKIELIST, &cookies); |
| 57 |
if(!res && cookies) { |
| 58 |
/* a linked list of cookies in cookie file format */ |
| 59 |
struct curl_slist *each = cookies; |
| 60 |
while(each) { |
| 61 |
printf("%s\\n", each->data); |
| 62 |
each = each->next; |
| 63 |
} |
| 64 |
/* we must free these cookies when we're done */ |
| 65 |
curl_slist_free_all(cookies); |
| 66 |
} |
| 67 |
} |
| 68 |
curl_easy_cleanup(curl); |
| 69 |
} |
| 70 |
.fi |
| 71 |
.SH AVAILABILITY |
| 72 |
Added in 7.14.1 |
| 73 |
.SH RETURN VALUE |
| 74 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 75 |
.SH "SEE ALSO" |
| 76 |
.BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), " |
| 77 |
.BR CURLOPT_COOKIELIST "(3), " |