curl / libcurl / API / curl_easy_setopt / CURLOPT_PROXYUSERNAME

CURLOPT_PROXYUSERNAME explained

Name

CURLOPT_PROXYUSERNAME - username to use for proxy authentication

Synopsis

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

Description

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

CURLOPT_PROXYUSERNAME sets the username to be used in protocol authentication with the proxy.

To specify the proxy password use the CURLOPT_PROXYPASSWORD.

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

Default

blank

Protocols

This functionality affects all supported protocols

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_PROXY, "http://localhost:8080");
    curl_easy_setopt(curl, CURLOPT_PROXYUSERNAME, "mrsmith");
    curl_easy_setopt(curl, CURLOPT_PROXYPASSWORD, "qwerty");
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

Availability

Added in curl 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.