Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_DNS_LOCAL_IP4.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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_DNS_LOCAL_IP4 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_DNS_LOCAL_IP4 \- IPv4 address to bind DNS resolves to
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DNS_LOCAL_IP4, char *address);
30 .SH DESCRIPTION
31 Set the local IPv4 \fIaddress\fP that the resolver should bind to. The
32 argument should be of type char * and contain a single numerical IPv4 address
33 as a string.  Set this option to NULL to use the default setting (don't bind
34 to a specific IP address).
35 .SH DEFAULT
36 NULL
37 .SH PROTOCOLS
38 All
39 .SH EXAMPLE
40 TODO
41 .SH AVAILABILITY
42 This option requires that libcurl was built with a resolver backend that
43 supports this operation. The c-ares backend is the only such one.
44
45 Added in 7.33.0
46 .SH RETURN VALUE
47 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not,
48 CURLE_NOT_BUILT_IN if support was disabled at compile-time, or
49 CURLE_BAD_FUNCTION_ARGUMENT when given a bad address.
50 .SH "SEE ALSO"
51 .BR CURLOPT_DNS_INTERFACE "(3), " CURLOPT_DNS_LOCAL_IP4 "(3), "