Home Explore Help
Sign In
OWEALs
/
curl
mirror of https://github.com/curl/curl.git
2
0
Fork 0
Files Issues 8 Wiki
Tree: 58c4b8d636
Branches Tags
curl
/
docs
/
libcurl
/
opts
/
CURLOPT_PROXY_SERVICE_NAME.3

CURLOPT_PROXY_SERVICE_NAME.3 2.2 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 
  1. .\" **************************************************************************
    2. 

  2. .\" *                                  _   _ ____  _
    3. 

  3. .\" *  Project                     ___| | | |  _ \| |
    4. 

  4. .\" *                             / __| | | | |_) | |
    5. 

  5. .\" *                            | (__| |_| |  _ <| |___
    6. 

  6. .\" *                             \___|\___/|_| \_\_____|
    7. 

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
    9. 

  9. .\" *
    10. 

  10. .\" * This software is licensed as described in the file COPYING, which
    11. 

  11. .\" * you should have received as part of this distribution. The terms
    12. 

  12. .\" * are also available at https://curl.se/docs/copyright.html.
    13. 

  13. .\" *
    14. 

  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
    15. 

  15. .\" * copies of the Software, and permit persons to whom the Software is
    16. 

  16. .\" * furnished to do so, under the terms of the COPYING file.
    17. 

  17. .\" *
    18. 

  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
    19. 

  19. .\" * KIND, either express or implied.
    20. 

  20. .\" *
    21. 

  21. .\" **************************************************************************
    22. 

  22. .\"
    23. 

  23. .TH CURLOPT_PROXY_SERVICE_NAME 3 "17 Jun 2015" "libcurl 7.43.0" "curl_easy_setopt options"
    24. 

  24. .SH NAME
    25. 

  25. CURLOPT_PROXY_SERVICE_NAME \- proxy authentication service name
    26. 

  26. .SH SYNOPSIS
    27. 

  27. #include <curl/curl.h>
    28. 

  28. 

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

  30. .SH DESCRIPTION
    31. 

  31. Pass a char * as parameter to a string holding the \fIname\fP of the
    32. 

  32. service. The default service name is "HTTP" for HTTP based proxies and "rcmd"
    33. 

  33. for SOCKS5. This option allows you to change it.
    34. 

  34. 

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

  36. option.
    37. 

  37. .SH DEFAULT
    38. 

  38. See above
    39. 

  39. .SH PROTOCOLS
    40. 

  40. All network protocols
    41. 

  41. .SH EXAMPLE
    42. 

  42. .nf
    43. 

  43. CURL *curl = curl_easy_init();
    44. 

  44. if(curl) {
    45. 

  45.   CURLcode ret;
    46. 

  46.   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    47. 

  47.   curl_easy_setopt(curl, CURLOPT_PROXY_SERVICE_NAME, "custom");
    48. 

  48.   ret = curl_easy_perform(curl);
    49. 

  49. }
    50. 

  50. .fi
    51. 

  51. .SH AVAILABILITY
    52. 

  52. Added in 7.43.0 for HTTP proxies, 7.49.0 for SOCKS5 proxies.
    53. 

  53. .SH RETURN VALUE
    54. 

  54. Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
    55. 

  55. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
    56. 

  56. .SH "SEE ALSO"
    57. 

  57. .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), "
    58.