2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-12-22 23:30:05 -07:00
repo/core/curl/files/CURLOPT_COOKIEJAR.3

68 lines
2.3 KiB
Groff
Raw Normal View History

.\" generated by cd2nroff 0.1 from CURLOPT_COOKIEJAR.md
2024-11-09 21:03:25 -07:00
.TH CURLOPT_COOKIEJAR 3 "2024-11-09" libcurl
.SH NAME
CURLOPT_COOKIEJAR \- filename to store cookies to
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEJAR, char *filename);
.fi
.SH DESCRIPTION
2024-09-15 18:10:01 -06:00
Pass a \fIfilename\fP as a char *, null\-terminated. This makes libcurl write all
internally known cookies to the specified file when \fIcurl_easy_cleanup(3)\fP is
called. If no cookies are kept in memory at that time, no file is 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 redirect it makes matching cookies get sent accordingly.
Note that libcurl does not read any cookies from the cookie jar specified with
this option. To read cookies from a file, use \fICURLOPT_COOKIEFILE(3)\fP.
If the cookie jar file cannot be created or written to (when the
2024-09-15 18:10:01 -06:00
\fIcurl_easy_cleanup(3)\fP is called), libcurl does not and cannot report an error
for this. Using \fICURLOPT_VERBOSE(3)\fP or \fICURLOPT_DEBUGFUNCTION(3)\fP displays a
warning, but that is the only visible feedback you get about this possibly
lethal situation.
Cookies are 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.
2024-09-15 18:10:01 -06:00
Using this option multiple times makes the last set string override the
previous ones. Set it to NULL to disable its use again.
.SH DEFAULT
NULL
.SH PROTOCOLS
2024-07-29 18:00:04 -06:00
This functionality affects http only
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode res;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
/* export cookies to this file when closing the handle */
curl_easy_setopt(curl, CURLOPT_COOKIEJAR, "/tmp/cookies.txt");
res = curl_easy_perform(curl);
2024-11-09 21:03:25 -07:00
/* close the handle, write the cookies */
curl_easy_cleanup(curl);
}
}
.fi
.SH AVAILABILITY
2024-07-29 18:00:04 -06:00
Added in curl 7.9
.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_COOKIE (3),
.BR CURLOPT_COOKIEFILE (3),
.BR CURLOPT_COOKIELIST (3)