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