48 lines
1.4 KiB
Groff
48 lines
1.4 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_PROXY_SERVICE_NAME.md
|
|
.TH CURLOPT_PROXY_SERVICE_NAME 3 "2024-09-25" libcurl
|
|
.SH NAME
|
|
CURLOPT_PROXY_SERVICE_NAME \- proxy authentication service name
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SERVICE_NAME,
|
|
char *name);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a char pointer as parameter to a string holding the \fIname\fP of the
|
|
service. The default service name is \fB"HTTP"\fP for HTTP based proxies and
|
|
\fB"rcmd"\fP for SOCKS5. This option allows you to change it.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
Using this option multiple times makes the last set string override the
|
|
previous ones. Set it to NULL to disable its use again.
|
|
.SH DEFAULT
|
|
See above
|
|
.SH PROTOCOLS
|
|
This functionality affects all supported protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode ret;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
curl_easy_setopt(curl, CURLOPT_PROXY_SERVICE_NAME, "custom");
|
|
ret = curl_easy_perform(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in curl 7.43.0
|
|
.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_PROXY (3),
|
|
.BR CURLOPT_PROXYTYPE (3),
|
|
.BR CURLOPT_SERVICE_NAME (3)
|