Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_IPRESOLVE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 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_IPRESOLVE 3 "May 05, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_IPRESOLVE \- specify which IP protocol version to use
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IPRESOLVE, long resolve);
31 .SH DESCRIPTION
32 Allows an application to select what kind of IP addresses to use when
33 resolving host names. This is only interesting when using host names that
34 resolve addresses using more than one version of IP. The allowed values are:
35 .IP CURL_IPRESOLVE_WHATEVER
36 Default, resolves addresses to all IP versions that your system allows.
37 .IP CURL_IPRESOLVE_V4
38 Resolve to IPv4 addresses.
39 .IP CURL_IPRESOLVE_V6
40 Resolve to IPv6 addresses.
41 .SH DEFAULT
42 CURL_IPRESOLVE_WHATEVER
43 .SH PROTOCOLS
44 All
45 .SH EXAMPLE
46 .nf
47 CURL *curl = curl_easy_init();
48 if(curl) {
49   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/foo.bin");
50
51   /* resolve host name using IPv6-names only */
52   curl_easy_setopt(curl, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V6);
53
54   ret = curl_easy_perform(curl);
55
56   curl_easy_cleanup(curl);
57 }
58 .fi
59
60 .SH AVAILABILITY
61 Always
62 .SH RETURN VALUE
63 Returns CURLE_OK
64 .SH "SEE ALSO"
65 .BR CURLOPT_HTTP_VERSION "(3), " CURLOPT_SSLVERSION "(3), "