CURLOPT_SOCKS5_GSSAPI_SERVICE.md (1482B)
1 --- 2 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 SPDX-License-Identifier: curl 4 Title: CURLOPT_SOCKS5_GSSAPI_SERVICE 5 Section: 3 6 Source: libcurl 7 See-also: 8 - CURLOPT_PROXY (3) 9 - CURLOPT_PROXYTYPE (3) 10 Protocol: 11 - All 12 Added-in: 7.19.4 13 --- 14 15 # NAME 16 17 CURLOPT_SOCKS5_GSSAPI_SERVICE - SOCKS5 proxy authentication service name 18 19 # SYNOPSIS 20 21 ~~~c 22 #include <curl/curl.h> 23 24 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKS5_GSSAPI_SERVICE, 25 char *name); 26 ~~~ 27 28 # DESCRIPTION 29 30 Deprecated since 7.49.0. Use CURLOPT_PROXY_SERVICE_NAME(3) instead. 31 32 Pass a char pointer as parameter to a string holding the *name* of the 33 service. The default service name for a SOCKS5 server is *rcmd*. This option 34 allows you to change it. 35 36 The application does not have to keep the string around after setting this 37 option. 38 39 # DEFAULT 40 41 See above 42 43 # %PROTOCOLS% 44 45 # EXAMPLE 46 47 ~~~c 48 int main(void) 49 { 50 CURL *curl = curl_easy_init(); 51 if(curl) { 52 CURLcode res; 53 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); 54 curl_easy_setopt(curl, CURLOPT_PROXY, "socks5://proxy"); 55 curl_easy_setopt(curl, CURLOPT_SOCKS5_GSSAPI_SERVICE, "rcmd-special"); 56 res = curl_easy_perform(curl); 57 curl_easy_cleanup(curl); 58 } 59 } 60 ~~~ 61 62 # DEPRECATED 63 64 Deprecated since 7.49.0 65 66 # %AVAILABILITY% 67 68 # RETURN VALUE 69 70 curl_easy_setopt(3) returns a CURLcode indicating success or error. 71 72 CURLE_OK (0) means everything was OK, non-zero means an error occurred, see 73 libcurl-errors(3).