diff options
Diffstat (limited to 'docs/libcurl/opts/GNURLOPT_COOKIEJAR.3')
| -rw-r--r-- | docs/libcurl/opts/GNURLOPT_COOKIEJAR.3 | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/docs/libcurl/opts/GNURLOPT_COOKIEJAR.3 b/docs/libcurl/opts/GNURLOPT_COOKIEJAR.3 new file mode 100644 index 000000000..eee777f9d --- /dev/null +++ b/docs/libcurl/opts/GNURLOPT_COOKIEJAR.3 @@ -0,0 +1,78 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2017, 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.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_COOKIEJAR 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_COOKIEJAR \- file name to store cookies to +.SH SYNOPSIS +#include <gnurl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEJAR, char *filename); +.SH DESCRIPTION +Pass a \fIfilename\fP as char *, zero terminated. This will make libcurl write +all internally known cookies to the specified file when +\fIcurl_easy_cleanup(3)\fP is called. If no cookies are known, no file will be +created. Specify "-" as filename to instead have the cookies written to +stdout. Using this option also enables cookies for this session, so if you for +example follow a location it will make matching cookies get sent accordingly. + +Note that libcurl doesn't read any cookies from the cookie jar. If you want to +read cookies from a file, use \fICURLOPT_COOKIEFILE(3)\fP. + +If the cookie jar file can't be created or written to (when the +\fIcurl_easy_cleanup(3)\fP is called), libcurl will not and cannot report an +error for this. Using \fICURLOPT_VERBOSE(3)\fP or +\fICURLOPT_DEBUGFUNCTION(3)\fP will get a warning to display, but that is the +only visible feedback you get about this possibly lethal situation. + +Since 7.43.0 cookies that were imported in the Set-Cookie format without a +domain name are not exported by this option. + +The application does not have to keep the string around after setting this +option. +.SH DEFAULT +NULL +.SH PROTOCOLS +HTTP +.SH EXAMPLE +.nf +CURL *curl = curl_easy_init(); +if(curl) { + curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin"); + + /* export cookies to this file when closing the handle */ + curl_easy_setopt(curl, CURLOPT_COOKIEJAR, "/tmp/cookies.txt"); + + ret = curl_easy_perform(curl); + + /* close the handle, write the cookies! */ + curl_easy_cleanup(curl); +} +.fi +.SH AVAILABILITY +Along with HTTP +.SH RETURN VALUE +Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or +CURLE_OUT_OF_MEMORY if there was insufficient heap space. +.SH "SEE ALSO" +.BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), " +.BR CURLOPT_COOKIELIST "(3), " |