diff options
Diffstat (limited to 'ares_set_servers_csv.3')
| -rw-r--r-- | ares_set_servers_csv.3 | 36 |
1 files changed, 35 insertions, 1 deletions
diff --git a/ares_set_servers_csv.3 b/ares_set_servers_csv.3 index a37c437..cad2078 100644 --- a/ares_set_servers_csv.3 +++ b/ares_set_servers_csv.3 @@ -15,7 +15,7 @@ .\" .TH ARES_SET_SERVERS_CSV 3 "30 June 2010" .SH NAME -ares_set_servers_csv \- Set list of DNS servers to be used. +ares_set_servers_csv, ares_set_servers_ports_csv \- Set list of DNS servers to be used. .SH SYNOPSIS .nf .B #include <ares.h> @@ -25,6 +25,12 @@ ares_set_servers_csv \- Set list of DNS servers to be used. .SH DESCRIPTION The \fBares_set_servers_csv\fP function sets the list of DNS servers that ARES will query. The format of the servers option is: +.B int ares_set_servers_csv(ares_channel \fIchannel\fP, const char* \fIservers\fP) +.B int ares_set_servers_ports_csv(ares_channel \fIchannel\fP, const char* \fIservers\fP) +.fi +.SH DESCRIPTION +The \fBares_set_servers_csv\fP and \fBares_set_servers_ports_csv\fPfunctions set +the list of DNS servers that ARES will query. The format of the servers option is: host[:port][,host[:port]]... @@ -39,5 +45,33 @@ The port option is currently ignored by c-ares internals and the standard port is always used. This function was added in c-ares 1.7.2 +.PP +The \fBares_set_servers_csv\fP function will ignore any port values specified in +the input string, whereare the \fBares_set_servers_ports_csv\fP function will +apply any specified port values as the UDP and TCP port to be used for that +particular nameserver. + +.SH RETURN VALUES +.B ares_set_servers_csv(3) +This function may return any of the following values: +.TP 15 +.B ARES_SUCCESS +The name servers configuration was successfully initialized. +.TP 15 +.B ARES_ENOMEM +The process's available memory was exhausted. +.TP 15 +.B ARES_ENODATA +The channel data identified by +.IR channel +was invalid. +.TP 15 +.B ARES_ENOTINITIALIZED +c-ares library initialization not yet performed. +.SH SEE ALSO +.BR ares_set_servers (3) +.SH AVAILABILITY +\fBares_set_servers_csv\fP was added in c-ares 1.7.2; +\fBares_set_servers_ports_csv\fP was added in c-ares 1.11.0. .SH AUTHOR Ben Greear |