curl / libcurl / API / curl_easy_setopt / CURLOPT_SOCKS5_GSSAPI_SERVICE

CURLOPT_SOCKS5_GSSAPI_SERVICE explained

Name

CURLOPT_SOCKS5_GSSAPI_SERVICE - SOCKS5 proxy authentication service name

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_SERVICE,
                          char *name);

Description

Deprecated since 7.49.0. Use CURLOPT_PROXY_SERVICE_NAME instead.

Pass a char * as parameter to a string holding the name of the service. The default service name for a SOCKS5 server is "rcmd". 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) {
  curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://proxy");
  curl_easy_setopt(curl, CURLOPT_SOCKS5_GSSAPI_SERVICE, "rcmd-special");
  ret = curl_easy_perform(curl);
  curl_easy_cleanup(curl);
}

Availability

Added in 7.19.4, deprecated in 7.49.0

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.