2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_PROXYUSERPWD.md
|
2024-08-02 19:52:59 -06:00
|
|
|
.TH CURLOPT_PROXYUSERPWD 3 "2024-08-02" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
2024-03-30 12:28:04 -06:00
|
|
|
CURLOPT_PROXYUSERPWD \- username and password to use for proxy authentication
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERPWD, char *userpwd);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
2024-03-30 12:28:04 -06:00
|
|
|
Pass a char pointer as parameter, which should be [username]:[password] to use
|
|
|
|
|
for the connection to the HTTP proxy. Both the name and the password are URL
|
|
|
|
|
decoded before used, so to include for example a colon in the username you
|
|
|
|
|
should encode it as %3A. (This is different to how \fICURLOPT_USERPWD(3)\fP is
|
2024-03-15 20:55:33 -06:00
|
|
|
used \- beware.)
|
|
|
|
|
|
|
|
|
|
Use \fICURLOPT_PROXYAUTH(3)\fP to specify the authentication method.
|
|
|
|
|
|
|
|
|
|
The application does not have to keep the string around after setting this
|
|
|
|
|
option.
|
|
|
|
|
.SH DEFAULT
|
2024-07-29 18:00:04 -06:00
|
|
|
NULL
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects all supported protocols
|
2024-03-15 20:55:33 -06:00
|
|
|
.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_PROXYUSERPWD, "clark%20kent:superman");
|
|
|
|
|
res = curl_easy_perform(curl);
|
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.1
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
|
|
|
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_PROXY (3),
|
|
|
|
|
.BR CURLOPT_PROXYPASSWORD (3),
|
|
|
|
|
.BR CURLOPT_PROXYTYPE (3),
|
|
|
|
|
.BR CURLOPT_PROXYUSERNAME (3)
|
