.\" generated by cd2nroff 0.1 from CURLOPT_PROXYUSERNAME.md
.TH CURLOPT_PROXYUSERNAME 3 "2024-11-18" libcurl
.SH NAME
CURLOPT_PROXYUSERNAME \- username to use for proxy authentication
.SH SYNOPSIS
.nf
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERNAME,
                          char *username);
.fi
.SH DESCRIPTION
Pass a char pointer as parameter, which should be pointing to the
null\-terminated username to use for the transfer.

\fICURLOPT_PROXYUSERNAME(3)\fP sets the username to be used in protocol
authentication with the proxy.

To specify the proxy password use the \fICURLOPT_PROXYPASSWORD(3)\fP.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
blank
.SH PROTOCOLS
This functionality affects all supported protocols
.SH EXAMPLE
.nf
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);
  }
}
.fi
.SH AVAILABILITY
Added in curl 7.19.1
.SH 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.
.SH SEE ALSO
.BR CURLOPT_HTTPAUTH (3),
.BR CURLOPT_PROXYAUTH (3),
.BR CURLOPT_PROXYPASSWORD (3),
.BR CURLOPT_USERNAME (3)