blob: 21b758d3e8ae890846e920eaca5ed4eb853ceb12 [file] [log] [blame]
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Elliott Hughes82be86d2017-09-20 17:00:17 -07008.\" * Copyright (C) 1998 - 2014, 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07009.\" *
10.\" * This software is licensed as described in the file COPYING, which
11.\" * you should have received as part of this distribution. The terms
Alex Deymo8f1a2142016-06-28 14:49:26 -070012.\" * are also available at https://curl.haxx.se/docs/copyright.html.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070013.\" *
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.\"
Haibo Huang65021c72019-03-27 15:37:23 -070023.TH CURLOPT_ADDRESS_SCOPE 3 "May 31, 2017" "libcurl 7.64.1" "curl_easy_setopt options"
Elliott Hughes82be86d2017-09-20 17:00:17 -070024
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070025.SH NAME
26CURLOPT_ADDRESS_SCOPE \- set scope for local IPv6 addresses
27.SH SYNOPSIS
28#include <curl/curl.h>
29
30CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ADDRESS_SCOPE, long scope);
31.SH DESCRIPTION
32Pass a long specifying the scope_id value to use when connecting to IPv6
33link-local or site-local addresses.
34.SH DEFAULT
350
36.SH PROTOCOLS
37All, when using IPv6
38.SH EXAMPLE
Elliott Hughes82be86d2017-09-20 17:00:17 -070039.nf
40CURL *curl = curl_easy_init();
41if(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
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070053.SH AVAILABILITY
54Added in 7.19.0
55.SH RETURN VALUE
56Returns 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), "