2014-06-19 07:53:13 -04:00
|
|
|
.\" **************************************************************************
|
|
|
|
|
.\" * _ _ ____ _
|
|
|
|
|
.\" * Project ___| | | | _ \| |
|
|
|
|
|
.\" * / __| | | | |_) | |
|
|
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
|
|
.\" *
|
|
|
|
|
.\" * Copyright (C) 1998 - 2014, 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 http://curl.haxx.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.
|
|
|
|
|
.\" *
|
|
|
|
|
.\" **************************************************************************
|
|
|
|
|
.\"
|
|
|
|
|
.TH CURLOPT_COOKIELIST 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_COOKIELIST \- add to or manipulate cookies held in memory
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIELIST,
|
|
|
|
|
char *cookie);
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a char * to a \fIcookie\fP string.
|
|
|
|
|
|
|
|
|
|
Such a cookie can be either a single line in Netscape / Mozilla format or just
|
|
|
|
|
regular HTTP-style header (Set-Cookie: ...) format. This will also enable the
|
|
|
|
|
cookie engine. This adds that single cookie to the internal cookie store.
|
|
|
|
|
|
|
|
|
|
Additionally, there are commands available that perform actions if you pass in
|
|
|
|
|
these exact strings:
|
|
|
|
|
.IP ALL
|
|
|
|
|
erases all cookies held in memory
|
|
|
|
|
|
|
|
|
|
.IP SESS
|
|
|
|
|
erases all session cookies held in memory
|
|
|
|
|
|
|
|
|
|
.IP FLUSH
|
|
|
|
|
writes all known cookies to the file specified by \fICURLOPT_COOKIEJAR(3)\fP
|
2014-09-25 10:25:52 -04:00
|
|
|
|
|
|
|
|
.IP RELOAD
|
|
|
|
|
loads all cookies from the files specified by \fICURLOPT_COOKIEFILE(3)\fP
|
|
|
|
|
|
2014-06-19 07:53:13 -04:00
|
|
|
.SH DEFAULT
|
|
|
|
|
NULL
|
|
|
|
|
.SH PROTOCOLS
|
|
|
|
|
HTTP
|
|
|
|
|
.SH EXAMPLE
|
|
|
|
|
TODO
|
|
|
|
|
.SH AVAILABILITY
|
|
|
|
|
ALL was added in 7.14.1
|
|
|
|
|
|
|
|
|
|
SESS was added in 7.15.4
|
|
|
|
|
|
|
|
|
|
FLUSH was added in 7.17.1
|
2014-09-25 10:25:52 -04:00
|
|
|
|
|
|
|
|
RELOAD was added in 7.39.0
|
2014-06-19 07:53:13 -04:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
|
.SH "SEE ALSO"
|
2014-09-18 16:58:12 -04:00
|
|
|
.BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIEJAR "(3), " CURLOPT_COOKIE "(3), "
|
