docs/libcurl/opts/CURLOPT_ADDRESS_SCOPE.3

   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.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_ADDRESS_SCOPE \- set scope for local IPv6 addresses
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ADDRESS_SCOPE, long scope);
  31 .SH DESCRIPTION
  32 Pass a long specifying the scope_id value to use when connecting to IPv6
  33 link-local or site-local addresses.
  34 .SH DEFAULT
  35 0
  36 .SH PROTOCOLS
  37 All, when using IPv6
  38 .SH EXAMPLE
  39 .nf
  40 CURL *curl = curl_easy_init();
  41 if(curl) {
  42   CURLcode ret;
  43   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  44   /* 0x2 link-local
  45      0x5 site-local
  46      0x8 organization-local
  47      0xe global ... */
  48   curl_easy_setopt(curl, CURLOPT_ADDRESS_SCOPE, 0xEL);
  49   ret = curl_easy_perform(curl);
  50   curl_easy_cleanup(curl);
  51 }
  52 .fi
  53 .SH AVAILABILITY
  54 Added in 7.19.0
  55 .SH RETURN VALUE
  56 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  57 .SH "SEE ALSO"
  58 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "