1 .\" **************************************************************************
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
8 .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
21 .\" **************************************************************************
23 .TH CURLOPT_COOKIEJAR 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
25 CURLOPT_COOKIEJAR \- file name to store cookies to
27 #include <curl/curl.h>
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEJAR, char *filename);
31 Pass a \fIfilename\fP as char *, zero terminated. This will make libcurl write
32 all internally known cookies to the specified file when
33 \fIcurl_easy_cleanup(3)\fP is called. If no cookies are known, no file will be
34 created. Specify "-" as filename to instead have the cookies written to
35 stdout. Using this option also enables cookies for this session, so if you for
36 example follow a location it will make matching cookies get sent accordingly.
38 Note that libcurl doesn't read any cookies from the cookie jar. If you want to
39 read cookies from a file, use \fICURLOPT_COOKIEFILE(3)\fP.
41 If the cookie jar file can't be created or written to (when the
42 \fIcurl_easy_cleanup(3)\fP is called), libcurl will not and cannot report an
43 error for this. Using \fICURLOPT_VERBOSE(3)\fP or
44 \fICURLOPT_DEBUGFUNCTION(3)\fP will get a warning to display, but that is the
45 only visible feedback you get about this possibly lethal situation.
47 Since 7.43.0 cookies that were imported in the Set-Cookie format without a
48 domain name are not exported by this option.
50 The application does not have to keep the string around after setting this
61 Returns CURLE_OK if HTTP is supported, CURLE_UNKNOWN_OPTION if not, or
62 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
64 .BR CURLOPT_COOKIEFILE "(3), " CURLOPT_COOKIE "(3), "
65 .BR CURLOPT_COOKIELIST "(3), "