CURLOPT_ADDRESS_SCOPE.3 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2014, 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
  9. .\" *
  10. .\" * This software is licensed as described in the file COPYING, which
  11. .\" * you should have received as part of this distribution. The terms
  12. .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13. .\" *
  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15. .\" * copies of the Software, and permit persons to whom the Software is
  16. .\" * furnished to do so, under the terms of the COPYING file.
  17. .\" *
  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19. .\" * KIND, either express or implied.
  20. .\" *
  21. .\" **************************************************************************
  22. .\"
  23. .TH CURLOPT_ADDRESS_SCOPE 3 "May 31, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_ADDRESS_SCOPE \- set scope for local IPv6 addresses
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ADDRESS_SCOPE, long scope);
  29. .SH DESCRIPTION
  30. Pass a long specifying the scope_id value to use when connecting to IPv6
  31. link-local or site-local addresses.
  32. .SH DEFAULT
  33. 0
  34. .SH PROTOCOLS
  35. All, when using IPv6
  36. .SH EXAMPLE
  37. .nf
  38. CURL *curl = curl_easy_init();
  39. if(curl) {
  40. CURLcode ret;
  41. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  42. /* 0x2 link-local
  43. 0x5 site-local
  44. 0x8 organization-local
  45. 0xe global ... */
  46. curl_easy_setopt(curl, CURLOPT_ADDRESS_SCOPE, 0xEL);
  47. ret = curl_easy_perform(curl);
  48. curl_easy_cleanup(curl);
  49. }
  50. .fi
  51. .SH AVAILABILITY
  52. Added in 7.19.0
  53. .SH RETURN VALUE
  54. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  55. .SH "SEE ALSO"
  56. .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "