| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950 |
- .\" generated by cd2nroff 0.1 from CURLOPT_PROXYUSERPWD.md
- .TH CURLOPT_PROXYUSERPWD 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_PROXYUSERPWD \- username and password to use for proxy authentication
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYUSERPWD, char *userpwd);
- .fi
- .SH DESCRIPTION
- 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
- 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
- NULL
- .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_PROXYUSERPWD, "clark%20kent:superman");
- res = curl_easy_perform(curl);
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.1
- .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)
|
