curl / libcurl / API / curl_easy_setopt / CURLOPT_NETRC_FILE

CURLOPT_NETRC_FILE explained

Name

CURLOPT_NETRC_FILE - file name to read .netrc info from

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NETRC_FILE, char *file);

Description

Pass a char * as parameter, pointing to a null-terminated string containing the full path name to the file you want libcurl to use as .netrc file. If this option is omitted, and CURLOPT_NETRC is set, libcurl will attempt to find a .netrc file in the current user's home directory.

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

Default

NULL

Protocols

All

Example

CURL *curl = curl_easy_init();
if(curl) {
  CURLcode ret;
  curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/");
  curl_easy_setopt(curl, CURLOPT_NETRC, CURL_NETRC_OPTIONAL);
  curl_easy_setopt(curl, CURLOPT_NETRC_FILE, "/tmp/magic-netrc");
  ret = curl_easy_perform(curl);
}

Availability

Added in 7.10.9

Return value

Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or CURLE_OUT_OF_MEMORY if there was insufficient heap space.