Return to CURLINFO_COOKIELIST.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLINFO_COOKIELIST.3, revision 1.1

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