lwres_gai_strerror.docbook revision 2eeb74d1cf5355dd98f6d507a10086e16bb08c4b
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder<!--
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder - Copyright (C) 2004, 2005, 2007, 2014 Internet Systems Consortium, Inc. ("ISC")
e6d40133bc9f858308654afb1262b8b483ec5922Till Mossakowski - Copyright (C) 2000, 2001 Internet Software Consortium.
1ea2ae9a4e73cdacc2a9db354ca4ce44e1d15835Christian Maeder -
98890889ffb2e8f6f722b00e265a211f13b5a861Corneliu-Claudiu Prodescu - Permission to use, copy, modify, and/or distribute this software for any
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder - purpose with or without fee is hereby granted, provided that the above
3f69b6948966979163bdfe8331c38833d5d90ecdChristian Maeder - copyright notice and this permission notice appear in all copies.
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder -
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
f3a94a197960e548ecd6520bb768cb0d547457bbChristian Maeder - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
e6d40133bc9f858308654afb1262b8b483ec5922Till Mossakowski - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder - PERFORMANCE OF THIS SOFTWARE.
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder-->
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder<!-- Converted by db4-upgrade version 1.0 -->
5f0d686f35e3cf510a32517fe5a2788d591964aeChristian Maeder<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder <info>
1f086d5155f47fdad9a0de4e46bbebb2c4b33d30Christian Maeder <date>2007-06-18</date>
812ee1f62e0e0e7235f3c05b41a0b173497b54ffChristian Maeder </info>
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder <refentryinfo>
1ea2ae9a4e73cdacc2a9db354ca4ce44e1d15835Christian Maeder <corpname>ISC</corpname>
7a47fbe6b987bd69a5056ce5d00fc8710f6c5e8aChristian Maeder <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
1ea2ae9a4e73cdacc2a9db354ca4ce44e1d15835Christian Maeder </refentryinfo>
5f0d686f35e3cf510a32517fe5a2788d591964aeChristian Maeder
5f0d686f35e3cf510a32517fe5a2788d591964aeChristian Maeder <refmeta>
812ee1f62e0e0e7235f3c05b41a0b173497b54ffChristian Maeder <refentrytitle>lwres_gai_strerror</refentrytitle>
812ee1f62e0e0e7235f3c05b41a0b173497b54ffChristian Maeder <manvolnum>3</manvolnum>
812ee1f62e0e0e7235f3c05b41a0b173497b54ffChristian Maeder <refmiscinfo>BIND9</refmiscinfo>
812ee1f62e0e0e7235f3c05b41a0b173497b54ffChristian Maeder </refmeta>
812ee1f62e0e0e7235f3c05b41a0b173497b54ffChristian Maeder
812ee1f62e0e0e7235f3c05b41a0b173497b54ffChristian Maeder <docinfo>
812ee1f62e0e0e7235f3c05b41a0b173497b54ffChristian Maeder <copyright>
812ee1f62e0e0e7235f3c05b41a0b173497b54ffChristian Maeder <year>2004</year>
5f0d686f35e3cf510a32517fe5a2788d591964aeChristian Maeder <year>2005</year>
de4dc9d0c3fae22c7bf7078f71f2aef46116c52aChristian Maeder <year>2007</year>
de4dc9d0c3fae22c7bf7078f71f2aef46116c52aChristian Maeder <year>2014</year>
fc2f3a651de218817ae63198a58cdc451e1b1eacChristian Maeder <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder </copyright>
5f0d686f35e3cf510a32517fe5a2788d591964aeChristian Maeder <copyright>
de4dc9d0c3fae22c7bf7078f71f2aef46116c52aChristian Maeder <year>2000</year>
de4dc9d0c3fae22c7bf7078f71f2aef46116c52aChristian Maeder <year>2001</year>
db6d512a0576744ed5fd507d8559920b4526e327Christian Maeder <holder>Internet Software Consortium.</holder>
db6d512a0576744ed5fd507d8559920b4526e327Christian Maeder </copyright>
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder </docinfo>
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder
1ea2ae9a4e73cdacc2a9db354ca4ce44e1d15835Christian Maeder <refnamediv>
9ecf13b5fd914bc7272f1fc17348d7f4a8c77061Christian Maeder <refname>lwres_gai_strerror</refname>
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder <refpurpose>print suitable error string</refpurpose>
0c3db2dbf698fecd0a4d0b39612b65b3398be343Christian Maeder </refnamediv>
0c3db2dbf698fecd0a4d0b39612b65b3398be343Christian Maeder
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder <refsynopsisdiv>
1f086d5155f47fdad9a0de4e46bbebb2c4b33d30Christian Maeder <funcsynopsis>
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
68e06f3c48e4d31d4956cf781d788ce114ffbb66Christian Maeder<funcprototype>
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder <funcdef>
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maederchar *
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder<function>gai_strerror</function></funcdef>
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder <paramdef>int <parameter>ecode</parameter></paramdef>
e539b8cb4a47f987bc57c90ee964219ac53841ffTill Mossakowski </funcprototype>
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder</funcsynopsis>
1ea2ae9a4e73cdacc2a9db354ca4ce44e1d15835Christian Maeder </refsynopsisdiv>
e539b8cb4a47f987bc57c90ee964219ac53841ffTill Mossakowski
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder <refsection><info><title>DESCRIPTION</title></info>
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder
e539b8cb4a47f987bc57c90ee964219ac53841ffTill Mossakowski
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder <para><function>lwres_gai_strerror()</function>
1ea2ae9a4e73cdacc2a9db354ca4ce44e1d15835Christian Maeder returns an error message corresponding to an error code returned by
7a47fbe6b987bd69a5056ce5d00fc8710f6c5e8aChristian Maeder <function>getaddrinfo()</function>.
bf3ce93c4f5dd0707a58458bf97c75385c88c343Christian Maeder The following error codes and their meaning are defined in
0c3db2dbf698fecd0a4d0b39612b65b3398be343Christian Maeder <filename>include/lwres/netdb.h</filename>.
0c3db2dbf698fecd0a4d0b39612b65b3398be343Christian Maeder <variablelist>
<varlistentry>
<term><errorcode>EAI_ADDRFAMILY</errorcode></term>
<listitem>
<para>
address family for hostname not supported
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_AGAIN</errorcode></term>
<listitem>
<para>
temporary failure in name resolution
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_BADFLAGS</errorcode></term>
<listitem>
<para>
invalid value for
<constant>ai_flags</constant>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_FAIL</errorcode></term>
<listitem>
<para>
non-recoverable failure in name resolution
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_FAMILY</errorcode></term>
<listitem>
<para><constant>ai_family</constant> not supported
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_MEMORY</errorcode></term>
<listitem>
<para>
memory allocation failure
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_NODATA</errorcode></term>
<listitem>
<para>
no address associated with hostname
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_NONAME</errorcode></term>
<listitem>
<para>
hostname or servname not provided, or not known
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_SERVICE</errorcode></term>
<listitem>
<para>
servname not supported for <constant>ai_socktype</constant>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_SOCKTYPE</errorcode></term>
<listitem>
<para><constant>ai_socktype</constant> not supported
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><errorcode>EAI_SYSTEM</errorcode></term>
<listitem>
<para>
system error returned in errno
</para>
</listitem>
</varlistentry>
</variablelist>
The message <errorname>invalid error code</errorname> is returned if
<parameter>ecode</parameter>
is out of range.
</para>
<para><constant>ai_flags</constant>,
<constant>ai_family</constant>
and
<constant>ai_socktype</constant>
are elements of the
<type>struct addrinfo</type>
used by
<function>lwres_getaddrinfo()</function>.
</para>
</refsection>
<refsection><info><title>SEE ALSO</title></info>
<para><citerefentry>
<refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>lwres_getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>RFC2133</refentrytitle>
</citerefentry>.
</para>
</refsection>
</refentry>