CURLOPT_COOKIEFILE - Man Page

file name to read cookies from

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_COOKIEFILE, char *filename);

Description

Pass a pointer to a null-terminated string as parameter. It should point to the file name of your file holding cookie data to read. The cookie data can be in either the old Netscape / Mozilla cookie data format or just regular HTTP headers (Set-Cookie style) dumped to a file.

It also enables the cookie engine, making libcurl parse and send cookies on subsequent requests with this handle.

Given an empty or non-existing file or by passing the empty string ("") to this option, you can enable the cookie engine without reading any initial cookies. If you tell libcurl the file name is "-" (just a single minus sign), libcurl will instead read from stdin.

This option only reads cookies. To make libcurl write cookies to file, see CURLOPT_COOKIEJAR(3).

If you use the Set-Cookie file format and don't specify a domain then the cookie is not sent since the domain will never match. To address this, set a domain in Set-Cookie line (doing that will include sub-domains) or preferably: use the Netscape format.

If you use this option multiple times, you just add more files to read. Subsequent files will add more cookies.

The application does not have to keep the string around after setting this option.

Setting this option to NULL will (since 7.77.0) explicitly disable the cookie engine and clear the list of files to read cookies from.

Default

NULL

Protocols

HTTP

Example

CURL *curl = curl_easy_init();
if(curl) {
  curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");

  /* get cookies from an existing file */
  curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "/tmp/cookies.txt");

  ret = curl_easy_perform(curl);

  curl_easy_cleanup(curl);
}

Availability

As long as HTTP is supported

Return Value

Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.

See Also

CURLOPT_COOKIE(3), CURLOPT_COOKIEJAR(3),

Referenced By

curl_easy_setopt(3), CURLOPT_ALTSVC(3), CURLOPT_COOKIE(3), CURLOPT_COOKIEJAR(3), CURLOPT_COOKIELIST(3), CURLOPT_COOKIESESSION(3), curl_share_setopt(3), libcurl-tutorial(3), nbdkit-curl-plugin(1).

May 16, 2021 libcurl 7.79.0 curl_easy_setopt options