Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_PASSWORD (3)

Name

CURLOPT_PASSWORD - password to use in authentication

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PASSWORD, char *pwd);

Description

CURLOPT_PASSWORD(3)        curl_easy_setopt options        CURLOPT_PASSWORD(3)



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 * as parameter, which should be pointing to the zero termi-
       nated password to use for the transfer.

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

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

DEFAULT
       blank

PROTOCOLS
       Most

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

         curl_easy_setopt(curl, CURLOPT_PASSWORD, "qwerty");

         ret = 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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLOPT_USERPWD(3),   CURLOPT_USERNAME(3),   CURLOPT_HTTPAUTH(3),  CUR-
       LOPT_PROXYAUTH(3)



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    19 Jun 2014              CURLOPT_PASSWORD(3)