Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_PROXY_SERVICE_NAME (3)

Name

CURLOPT_PROXY_SERVICE_NAME - proxy authentication service name

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SERVICE_NAME,
char *name);

Description

curl_easy_setopt options                         CURLOPT_PROXY_SERVICE_NAME(3)



NAME
       CURLOPT_PROXY_SERVICE_NAME - proxy authentication service name

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SERVICE_NAME,
                                 char *name);

DESCRIPTION
       Pass a char * as parameter to a string holding the name of the service.
       The default service name is "HTTP" for HTTP based  proxies  and  "rcmd"
       for SOCKS5. This option allows you to change it.

       The  application  does not have to keep the string around after setting
       this option.

DEFAULT
       See above

PROTOCOLS
       All network protocols

EXAMPLE
       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);
       }

AVAILABILITY
       Added in 7.43.0 for HTTP proxies, 7.49.0 for SOCKS5 proxies.

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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       CURLOPT_PROXY(3), CURLOPT_PROXYTYPE(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021
                                                 CURLOPT_PROXY_SERVICE_NAME(3)