Manpages - CURLOPT_PROXYUSERNAME.3

Table of Contents

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 null-terminated 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, "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");
    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.

SEE ALSO

*CURLOPT_PROXYPASSWORD*(3), *CURLOPT_USERNAME*(3), *CURLOPT_HTTPAUTH*(3), *CURLOPT_PROXYAUTH*(3)

Author: dt

Created: 2022-02-20 Sun 14:51