2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-12-24 00:10:05 -07:00
repo/core/curl/files/CURLOPT_PROXYPASSWORD.3

50 lines
1.5 KiB
Groff
Raw Normal View History

.\" generated by cd2nroff 0.1 from CURLOPT_PROXYPASSWORD.md
2024-07-29 18:00:04 -06:00
.TH CURLOPT_PROXYPASSWORD 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_PROXYPASSWORD \- password to use with proxy authentication
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYPASSWORD, char *pwd);
.fi
.SH DESCRIPTION
Pass a char pointer as parameter, which should be pointing to the null\-terminated
password to use for authentication with the proxy.
The \fICURLOPT_PROXYPASSWORD(3)\fP option should be used in conjunction with
the \fICURLOPT_PROXYUSERNAME(3)\fP option.
The application does not have to keep the string around after setting this
option.
.SH DEFAULT
blank
.SH PROTOCOLS
2024-07-29 18:00:04 -06:00
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
2024-07-29 18:00:04 -06:00
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_PASSWORD (3),
.BR CURLOPT_PROXYAUTH (3),
.BR CURLOPT_PROXYUSERNAME (3)