Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_PROXYUSERNAME (3)

Name

CURLOPT_PROXYUSERNAME - user name to use for proxy authentication

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERNAME,
char *username);

Description

CURLOPT_PROXYUSERNAME(3)   curl_easy_setopt options   CURLOPT_PROXYUSERNAME(3)



NAME
       CURLOPT_PROXYUSERNAME - user name to use for proxy authentication

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERNAME,
                                 char *username);

DESCRIPTION
       Pass a char * as parameter, which should be pointing to the zero termi-
       nated user name to use for the transfer.

       CURLOPT_PROXYUSERNAME(3) sets the user name  to  be  used  in  protocol
       authentication with the proxy.

       To specify the proxy password use the CURLOPT_PROXYPASSWORD(3).

       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_PROXY, "http://localhost:8080");
         curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, "mrsmith");
         curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, "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_PROXYPASSWORD(3),   CURLOPT_USERNAME(3),   CURLOPT_HTTPAUTH(3),
       CURLOPT_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_PROXYUSERNAME(3)