docs/libcurl/opts/CURLOPT_COOKIELIST.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLOPT_COOKIELIST man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 P.level0 {
   8  padding-left: 2em;
   9 }
  10
  11 P.level1 {
  12  padding-left: 4em;
  13 }
  14
  15 P.level2 {
  16  padding-left: 6em;
  17 }
  18
  19 span.emphasis {
  20  font-style: italic;
  21 }
  22
  23 span.bold {
  24  font-weight: bold;
  25 }
  26
  27 span.manpage {
  28  font-weight: bold;
  29 }
  30
  31 h2.nroffsh {
  32  background-color: #e0e0e0;
  33 }
  34
  35 span.nroffip {
  36  font-weight: bold;
  37  font-size: 120%;
  38  font-family: monospace;
  39 }
  40
  41 p.roffit {
  42  text-align: center;
  43  font-size: 80%;
  44 }
  45 </STYLE>
  46 </head><body>
  47
  48 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  49 <p class="level0">CURLOPT_COOKIELIST - add to or manipulate cookies held in memory <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  50 <p class="level0"><pre>
  51 <p class="level0">#include &lt;curl/curl.h&gt;
  52  <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIELIST,
  53  &nbsp;                         char *cookie);
  54  </pre>
  55 <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  56 <p class="level0">Pass a char * to a <span Class="emphasis">cookie</span> string.
  57 <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.
  58 <p class="level0">Additionally, there are commands available that perform actions if you pass in these exact strings:
  59 <p class="level0"><a name="ALL"></a><span class="nroffip">ALL</span>
  60 <p class="level1">erases all cookies held in memory
  61 <p class="level1">
  62 <p class="level0"><a name="SESS"></a><span class="nroffip">SESS</span>
  63 <p class="level1">erases all session cookies held in memory
  64 <p class="level1">
  65 <p class="level0"><a name="FLUSH"></a><span class="nroffip">FLUSH</span>
  66 <p class="level1">writes all known cookies to the file specified by <a Class="emphasis" href="./CURLOPT_COOKIEJAR.html">CURLOPT_COOKIEJAR</a>
  67 <p class="level1">
  68 <p class="level0"><a name="RELOAD"></a><span class="nroffip">RELOAD</span>
  69 <p class="level1">loads all cookies from the files specified by <a Class="emphasis" href="./CURLOPT_COOKIEFILE.html">CURLOPT_COOKIEFILE</a>
  70 <p class="level1"><a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  71 <p class="level0">NULL <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  72 <p class="level0">HTTP <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  73 <p class="level0">TODO <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
  74 <p class="level0">ALL was added in 7.14.1
  75 <p class="level0">SESS was added in 7.15.4
  76 <p class="level0">FLUSH was added in 7.17.1
  77 <p class="level0">RELOAD was added in 7.39.0 <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
  78 <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>
  79 <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>, <span Class="manpage"> </span> <p class="roffit">
  80  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
  81 </body></html>