1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_PROXY_SERVICE_NAME
5Section: 3
6Source: libcurl
7See-also:
8  - CURLOPT_PROXY (3)
9  - CURLOPT_PROXYTYPE (3)
10  - CURLOPT_SERVICE_NAME (3)
11Protocol:
12  - All
13---
14
15# NAME
16
17CURLOPT_PROXY_SERVICE_NAME - proxy authentication service name
18
19# SYNOPSIS
20
21~~~c
22#include <curl/curl.h>
23
24CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SERVICE_NAME,
25                          char *name);
26~~~
27
28# DESCRIPTION
29
30Pass a char pointer as parameter to a string holding the *name* of the
31service. The default service name is **"HTTP"** for HTTP based proxies and
32**"rcmd"** for SOCKS5. This option allows you to change it.
33
34The application does not have to keep the string around after setting this
35option.
36
37# DEFAULT
38
39See above
40
41# EXAMPLE
42
43~~~c
44int main(void)
45{
46  CURL *curl = curl_easy_init();
47  if(curl) {
48    CURLcode ret;
49    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
50    curl_easy_setopt(curl, CURLOPT_PROXY_SERVICE_NAME, "custom");
51    ret = curl_easy_perform(curl);
52  }
53}
54~~~
55
56# AVAILABILITY
57
58Added in 7.43.0 for HTTP proxies, 7.49.0 for SOCKS5 proxies.
59
60# RETURN VALUE
61
62Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
63CURLE_OUT_OF_MEMORY if there was insufficient heap space.
64