lwres_gai_strerror.docbook revision 0c27b3fe77ac1d5094ba3521e8142d9e7973133f
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!--
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt - Copyright (C) 2000, 2001, 2004, 2005, 2007, 2014-2016 Internet Systems Consortium, Inc. ("ISC")
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson -
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - This Source Code Form is subject to the terms of the Mozilla Public
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson - License, v. 2.0. If a copy of the MPL was not distributed with this
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews - file, You can obtain one at http://mozilla.org/MPL/2.0/.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews-->
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson<!-- Converted by db4-upgrade version 1.0 -->
19c7b1a0293498a3e36692c59646ed6e15ffc8d0Tinderbox User<refentry xmlns="http://docbook.org/ns/docbook" version="5.0">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <info>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <date>2007-06-18</date>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </info>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <refentryinfo>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt <corpname>ISC</corpname>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <corpauthor>Internet Systems Consortium, Inc.</corpauthor>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </refentryinfo>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refmeta>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refentrytitle>lwres_gai_strerror</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <manvolnum>3</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refmiscinfo>BIND9</refmiscinfo>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refmeta>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <docinfo>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2004</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2005</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2007</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2014</year>
c1a883f2e04d94e99c433b1f6cfd0c0338f4ed85Mark Andrews <year>2015</year>
938440694b33cd752e9e4b71a526368b4811c177Tinderbox User <year>2016</year>
19c7b1a0293498a3e36692c59646ed6e15ffc8d0Tinderbox User <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews </copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2000</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <year>2001</year>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <holder>Internet Software Consortium.</holder>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </copyright>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </docinfo>
f5d30e2864e048a42c4dc1134993ae7efdb5d6c3Mark Andrews
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refname>lwres_gai_strerror</refname>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refpurpose>print suitable error string</refpurpose>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refnamediv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsynopsisdiv>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <funcsynopsis>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<funcprototype>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <funcdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austeinchar *
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein<function>gai_strerror</function></funcdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <paramdef>int <parameter>ecode</parameter></paramdef>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </funcprototype>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</funcsynopsis>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </refsynopsisdiv>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsection><info><title>DESCRIPTION</title></info>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><function>lwres_gai_strerror()</function>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein returns an error message corresponding to an error code returned by
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <function>getaddrinfo()</function>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The following error codes and their meaning are defined in
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <filename>include/lwres/netdb.h</filename>.
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <variablelist>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term><errorcode>EAI_ADDRFAMILY</errorcode></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein address family for hostname not supported
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><errorcode>EAI_AGAIN</errorcode></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson temporary failure in name resolution
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </listitem>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><errorcode>EAI_BADFLAGS</errorcode></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson invalid value for
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <constant>ai_flags</constant>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <term><errorcode>EAI_FAIL</errorcode></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <para>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson non-recoverable failure in name resolution
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><errorcode>EAI_FAMILY</errorcode></term>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <listitem>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <para><constant>ai_family</constant> not supported
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><errorcode>EAI_MEMORY</errorcode></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson memory allocation failure
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt </listitem>
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews </varlistentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><errorcode>EAI_NODATA</errorcode></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein no address associated with hostname
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><errorcode>EAI_NONAME</errorcode></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein hostname or servname not provided, or not known
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><errorcode>EAI_SERVICE</errorcode></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein servname not supported for <constant>ai_socktype</constant>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><errorcode>EAI_SOCKTYPE</errorcode></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><constant>ai_socktype</constant> not supported
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <term><errorcode>EAI_SYSTEM</errorcode></term>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein system error returned in errno
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </listitem>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </varlistentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </variablelist>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein The message <errorname>invalid error code</errorname> is returned if
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <parameter>ecode</parameter>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein is out of range.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <para><constant>ai_flags</constant>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <constant>ai_family</constant>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein and
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <constant>ai_socktype</constant>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein are elements of the
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <type>struct addrinfo</type>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson used by
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <function>lwres_getaddrinfo()</function>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsection>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refsection><info><title>SEE ALSO</title></info>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <para><citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>lwres_getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>,
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein <citerefentry>
ddccd5811feff696ba460dabfb666ce61040f545Andreas Gustafsson <refentrytitle>RFC2133</refentrytitle>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </citerefentry>.
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </para>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein </refsection>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein</refentry>
268a4475065fe6a8cd7cc707820982cf5e98f430Rob Austein