curl / libcurl / API / curl_easy_setopt / CURLOPT_PASSWORD

CURLOPT_PASSWORD explained

Name

CURLOPT_PASSWORD - password to use in authentication

Synopsis

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

Description

Pass a char pointer as parameter, which should be pointing to the null-terminated password to use for the transfer.

The CURLOPT_PASSWORD option should be used in conjunction with the CURLOPT_USERNAME option.

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

Default

blank

Protocols

All

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/foo.bin");
 
    curl_easy_setopt(curl, CURLOPT_PASSWORD, "qwerty");
 
    res = curl_easy_perform(curl);
 
    curl_easy_cleanup(curl);
  }
}

Availability

Added in 7.19.1

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.