diff options
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_COOKIE.3')
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_COOKIE.3 | 90 |
1 files changed, 0 insertions, 90 deletions
diff --git a/docs/libcurl/opts/CURLOPT_COOKIE.3 b/docs/libcurl/opts/CURLOPT_COOKIE.3 deleted file mode 100644 index b7de3ebe2..000000000 --- a/docs/libcurl/opts/CURLOPT_COOKIE.3 +++ /dev/null @@ -1,90 +0,0 @@ -.\" ************************************************************************** -.\" * _ _ ____ _ -.\" * Project ___| | | | _ \| | -.\" * / __| | | | |_) | | -.\" * | (__| |_| | _ <| |___ -.\" * \___|\___/|_| \_\_____| -.\" * -.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. -.\" * -.\" * This software is licensed as described in the file COPYING, which -.\" * you should have received as part of this distribution. The terms -.\" * are also available at https://curl.se/docs/copyright.html. -.\" * -.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell -.\" * copies of the Software, and permit persons to whom the Software is -.\" * furnished to do so, under the terms of the COPYING file. -.\" * -.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY -.\" * KIND, either express or implied. -.\" * -.\" * SPDX-License-Identifier: curl -.\" * -.\" ************************************************************************** -.\" -.TH CURLOPT_COOKIE 3 "17 Jun 2014" libcurl libcurl -.SH NAME -CURLOPT_COOKIE \- HTTP Cookie header -.SH SYNOPSIS -.nf -#include <curl/curl.h> - -CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIE, char *cookie); -.fi -.SH DESCRIPTION -Pass a pointer to a null-terminated string as parameter. It is used to set one -or more cookies in the HTTP request. The format of the string should be -NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie -should contain. - -To set multiple cookies, set them all using a single option concatenated like -this: "name1=content1; name2=content2;" etc. - -This option sets the cookie header explicitly in the outgoing request(s). If -multiple requests are done due to authentication, followed redirections or -similar, they all get this cookie passed on. - -The cookies set by this option are separate from the internal cookie storage -held by the cookie engine and they are not be modified by it. If you enable -the cookie engine and either you have imported a cookie of the same name -(e.g. 'foo') or the server has set one, it has no effect on the cookies you -set here. A request to the server sends both the 'foo' held by the cookie -engine and the 'foo' held by this option. To set a cookie that is instead held -by the cookie engine and can be modified by the server use -\fICURLOPT_COOKIELIST(3)\fP. - -Using this option multiple times makes the last set string override the -previous ones. - -This option does not enable the cookie engine. Use \fICURLOPT_COOKIEFILE(3)\fP -or \fICURLOPT_COOKIEJAR(3)\fP to enable parsing and sending cookies -automatically. - -The application does not have to keep the string around after setting this -option. -.SH DEFAULT -NULL, no cookies -.SH PROTOCOLS -HTTP -.SH EXAMPLE -.nf -CURL *curl = curl_easy_init(); -if(curl) { - curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); - - curl_easy_setopt(curl, CURLOPT_COOKIE, "tool=curl; fun=yes;"); - - curl_easy_perform(curl); -} -.fi -.SH AVAILABILITY -If HTTP is enabled -.SH RETURN VALUE -Returns CURLE_OK if HTTP is enabled, CURLE_UNKNOWN_OPTION if not, or -CURLE_OUT_OF_MEMORY if there was insufficient heap space. -.SH "SEE ALSO" -.BR CURLINFO_COOKIELIST (3), -.BR CURLOPT_COOKIEFILE (3), -.BR CURLOPT_COOKIEJAR (3), -.BR CURLOPT_COOKIELIST (3), -.BR CURLOPT_HTTPHEADER (3) |