| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 |
- .\" generated by cd2nroff 0.1 from CURLINFO_COOKIELIST.md
- .TH CURLINFO_COOKIELIST 3 "2025-01-17" libcurl
- .SH NAME
- CURLINFO_COOKIELIST \- get all known cookies
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_COOKIELIST,
- struct curl_slist **cookies);
- .fi
- .SH DESCRIPTION
- Pass a pointer to a \(aqstruct curl_slist *\(aq to receive a linked\-list of all
- cookies curl knows (expired ones, too). Do not forget to call
- \fIcurl_slist_free_all(3)\fP 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) the \(aqstruct curl_slist *\(aq is made a NULL pointer.
- Since 7.43.0 cookies that were imported in the Set\-Cookie format without a
- domain name are not exported by this option.
- .SH PROTOCOLS
- This functionality affects http only
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- if(curl) {
- CURLcode res;
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
- /* enable the cookie engine */
- 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\\n", each->data);
- each = each->next;
- }
- /* we must free these cookies when we are done */
- curl_slist_free_all(cookies);
- }
- }
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.14.1
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLOPT_COOKIELIST (3),
- .BR curl_easy_getinfo (3),
- .BR curl_easy_setopt (3)
|