lwres_gai_strerror.docbook revision 30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1
306N/A<!--
306N/A - Copyright (C) 2004, 2005, 2007, 2014, 2015 Internet Systems Consortium, Inc. ("ISC")
306N/A - Copyright (C) 2000, 2001 Internet Software Consortium.
306N/A -
306N/A - Permission to use, copy, modify, and/or distribute this software for any
306N/A - purpose with or without fee is hereby granted, provided that the above
306N/A - copyright notice and this permission notice appear in all copies.
306N/A -
306N/A - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
306N/A - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
306N/A - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
306N/A - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
306N/A - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
306N/A - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
306N/A - PERFORMANCE OF THIS SOFTWARE.
306N/A-->
306N/A
306N/A<!-- Converted by db4-upgrade version 1.0 -->
306N/A<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
306N/A <info>
306N/A <date>2007-06-18</date>
306N/A </info>
3996N/A <refentryinfo>
306N/A <corpname>ISC</corpname>
306N/A <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
306N/A </refentryinfo>
306N/A
306N/A <refmeta>
708N/A <refentrytitle>lwres_gai_strerror</refentrytitle>
306N/A <manvolnum>3</manvolnum>
306N/A <refmiscinfo>BIND9</refmiscinfo>
306N/A </refmeta>
844N/A
844N/A <docinfo>
306N/A <copyright>
1273N/A <year>2004</year>
306N/A <year>2005</year>
3290N/A <year>2007</year>
3290N/A <year>2014</year>
3996N/A <year>2015</year>
3996N/A <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
3996N/A </copyright>
306N/A <copyright>
306N/A <year>2000</year>
306N/A <year>2001</year>
306N/A <holder>Internet Software Consortium.</holder>
306N/A </copyright>
306N/A </docinfo>
306N/A
306N/A <refnamediv>
306N/A <refname>lwres_gai_strerror</refname>
306N/A <refpurpose>print suitable error string</refpurpose>
708N/A </refnamediv>
306N/A
306N/A <refsynopsisdiv>
306N/A <funcsynopsis>
306N/A<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
306N/A<funcprototype>
306N/A <funcdef>
708N/Achar *
306N/A<function>gai_strerror</function></funcdef>
306N/A <paramdef>int <parameter>ecode</parameter></paramdef>
3996N/A </funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsection><info><title>DESCRIPTION</title></info>
<para><function>lwres_gai_strerror()</function>
returns an error message corresponding to an error code returned by
<function>getaddrinfo()</function>.
The following error codes and their meaning are defined in
<filename>include/lwres/netdb.h</filename>.
<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>