Return to CURLOPT_COOKIE.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_COOKIE.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 CURLOPT_COOKIE 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_COOKIE \- set contents of HTTP Cookie header
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIE, char *cookie);
        !            31: .SH DESCRIPTION
        !            32: Pass a pointer to a zero terminated string as parameter. It will be used to
        !            33: set a cookie in the HTTP request. The format of the string should be
        !            34: NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie
        !            35: should contain.
        !            36: 
        !            37: If you need to set multiple cookies, set them all using a single option
        !            38: concatenated like this: "name1=content1; name2=content2;" etc.
        !            39: 
        !            40: This option sets the cookie header explicitly in the outgoing request(s). If
        !            41: multiple requests are done due to authentication, followed redirections or
        !            42: similar, they will all get this cookie passed on.
        !            43: 
        !            44: The cookies set by this option are separate from the internal cookie storage
        !            45: held by the cookie engine and will not be modified by it. If you enable the
        !            46: cookie engine and either you've imported a cookie of the same name (e.g. 'foo')
        !            47: or the server has set one, it will have no effect on the cookies you set here.
        !            48: A request to the server will send both the 'foo' held by the cookie engine and
        !            49: the 'foo' held by this option. To set a cookie that is instead held by the
        !            50: cookie engine and can be modified by the server use
        !            51: \fICURLOPT_COOKIELIST(3)\fP.
        !            52: 
        !            53: Using this option multiple times will only make the latest string override the
        !            54: previous ones.
        !            55: 
        !            56: This option will not enable the cookie engine. Use \fICURLOPT_COOKIEFILE(3)\fP
        !            57: or \fICURLOPT_COOKIEJAR(3)\fP to enable parsing and sending cookies
        !            58: automatically.
        !            59: 
        !            60: The application does not have to keep the string around after setting this
        !            61: option.
        !            62: .SH DEFAULT
        !            63: NULL, no cookies
        !            64: .SH PROTOCOLS
        !            65: HTTP
        !            66: .SH EXAMPLE
        !            67: .nf
        !            68: CURL *curl = curl_easy_init();
        !            69: if(curl) {
        !            70:   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
        !            71: 
        !            72:   curl_easy_setopt(curl, CURLOPT_COOKIE, "tool=curl; fun=yes;");
        !            73: 
        !            74:   curl_easy_perform(curl);
        !            75: }
        !            76: .fi
        !            77: .SH AVAILABILITY
        !            78: If HTTP is enabled
        !            79: .SH RETURN VALUE
        !            80: Returns CURLE_OK if HTTP is enabled, CURLE_UNKNOWN_OPTION if not, or
        !            81: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
        !            82: .SH "SEE ALSO"
        !            83: .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIEJAR "(3), "  CURLOPT_COOKIELIST "(3), "
        !            84: .BR CURLOPT_HTTPHEADER "(3), "