1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
4 <title>CURLOPT_COOKIELIST man page</title>
5 <meta name="generator" content="roffit">
6 <STYLE type="text/css">
12 P.level0, pre.level0 {
16 P.level1, pre.level1 {
20 P.level2, pre.level2 {
37 background-color: #e0e0e0;
43 font-family: monospace;
53 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
54 <p class="level0">CURLOPT_COOKIELIST - add to or manipulate cookies held in memory <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
55 <p class="level0"><pre class="level0">
56 #include <curl/curl.h>
58 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIELIST,
61 <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
62 <p class="level0">Pass a char * to a <span Class="emphasis">cookie</span> string.
63 <p class="level0">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.
64 <p class="level0">Exercise caution if you are using this option and multiple transfers may occur. If you use the Set-Cookie format and don't specify a domain then the cookie is sent for any domain (even after redirects are followed) and cannot be modified by a server-set cookie. If a server sets a cookie of the same name (or maybe you've imported one) then both will be sent on a future transfer to that server, likely not what you intended. To address these issues set a domain in Set-Cookie (doing that will include sub-domains) or use the Netscape format as shown in EXAMPLE.
65 <p class="level0">Additionally, there are commands available that perform actions if you pass in these exact strings:
66 <p class="level0"><a name="ALL"></a><span class="nroffip">ALL</span>
67 <p class="level1">erases all cookies held in memory
69 <p class="level0"><a name="SESS"></a><span class="nroffip">SESS</span>
70 <p class="level1">erases all session cookies held in memory
72 <p class="level0"><a name="FLUSH"></a><span class="nroffip">FLUSH</span>
73 <p class="level1">writes all known cookies to the file specified by <a Class="emphasis" href="./CURLOPT_COOKIEJAR.html">CURLOPT_COOKIEJAR</a>
75 <p class="level0"><a name="RELOAD"></a><span class="nroffip">RELOAD</span>
76 <p class="level1">loads all cookies from the files specified by <a Class="emphasis" href="./CURLOPT_COOKIEFILE.html">CURLOPT_COOKIEFILE</a>
77 <p class="level1"><a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
78 <p class="level0">NULL <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
79 <p class="level0">HTTP <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
80 <p class="level0"><pre class="level0">
81 /* This example shows an inline import of a cookie in Netscape format.
82 You can set the cookie as HttpOnly to prevent XSS attacks by prepending
83 #HttpOnly_ to the hostname. That may be useful if the cookie will later
84 be imported by a browser.
87 #define SEP "\t" /* Tab separates the fields */
90 "example.com" /* Hostname */
91 SEP "FALSE" /* Include subdomains */
92 SEP "/" /* Path */
93 SEP "FALSE" /* Secure */
94 SEP "0" /* Expiry in epoch time format. 0 == Session */
95 SEP "foo" /* Name */
96 SEP "bar"; /* Value */
98 /* my_cookie is imported immediately via CURLOPT_COOKIELIST.
100 curl_easy_setopt(curl, CURLOPT_COOKIELIST, my_cookie);
102 /* The list of cookies in cookies.txt will not be imported until right
103 before a transfer is performed. Cookies in the list that have the same
104 hostname, path and name as in my_cookie are skipped. That is because
105 libcurl has already imported my_cookie and it's considered a "live"
106 cookie. A live cookie won't be replaced by one read from a file.
108 curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "cookies.txt"); /* import */
110 /* Cookies are exported after curl_easy_cleanup is called. The server
111 may have added, deleted or modified cookies by then. The cookies that
112 were skipped on import are not exported.
114 curl_easy_setopt(curl, CURLOPT_COOKIEJAR, "cookies.txt"); /* export */
116 res = curl_easy_perform(curl); /* cookies imported from cookies.txt */
118 curl_easy_cleanup(curl); /* cookies exported to cookies.txt */
121 <p class="level0"><a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
122 <p class="level0">ALL was added in 7.14.1
123 <p class="level0">SESS was added in 7.15.4
124 <p class="level0">FLUSH was added in 7.17.1
125 <p class="level0">RELOAD was added in 7.39.0 <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
126 <p class="level0">Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
127 <p class="level0"><a Class="manpage" href="./CURLOPT_COOKIEFILE.html">CURLOPT_COOKIEFILE</a>, <a Class="manpage" href="./CURLOPT_COOKIEJAR.html">CURLOPT_COOKIEJAR</a>, <a Class="manpage" href="./CURLOPT_COOKIE.html">CURLOPT_COOKIE</a>, <a Class="manpage" href="./CURLINFO_COOKIELIST.html">CURLINFO_COOKIELIST</a><p class="roffit">
128 This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.