contrib/bind9/lib/lwres/man/lwres_gai_strerror.docbook

   1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   2                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
   3                [<!ENTITY mdash "&#8212;">]>
   4 <!--
   5  - Copyright (C) 2004, 2005, 2007, 2012  Internet Systems Consortium, Inc. ("ISC")
   6  - Copyright (C) 2000, 2001  Internet Software Consortium.
   7  -
   8  - Permission to use, copy, modify, and/or distribute this software for any
   9  - purpose with or without fee is hereby granted, provided that the above
  10  - copyright notice and this permission notice appear in all copies.
  11  -
  12  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  13  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  14  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  15  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  16  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  17  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  18  - PERFORMANCE OF THIS SOFTWARE.
  19 -->
  20
  21 <!-- $Id$ -->
  22 <refentry>
  23
  24   <refentryinfo>
  25     <date>Jun 30, 2000</date>
  26   </refentryinfo>
  27
  28   <refmeta>
  29     <refentrytitle>lwres_gai_strerror</refentrytitle>
  30     <manvolnum>3</manvolnum>
  31     <refmiscinfo>BIND9</refmiscinfo>
  32   </refmeta>
  33
  34   <docinfo>
  35     <copyright>
  36       <year>2004</year>
  37       <year>2005</year>
  38       <year>2007</year>
  39       <year>2012</year>
  40       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  41     </copyright>
  42     <copyright>
  43       <year>2000</year>
  44       <year>2001</year>
  45       <holder>Internet Software Consortium.</holder>
  46     </copyright>
  47   </docinfo>
  48
  49   <refnamediv>
  50     <refname>lwres_gai_strerror</refname>
  51     <refpurpose>print suitable error string</refpurpose>
  52   </refnamediv>
  53
  54   <refsynopsisdiv>
  55     <funcsynopsis>
  56 <funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
  57 <funcprototype>
  58         <funcdef>
  59 char *
  60 <function>gai_strerror</function></funcdef>
  61         <paramdef>int <parameter>ecode</parameter></paramdef>
  62       </funcprototype>
  63 </funcsynopsis>
  64   </refsynopsisdiv>
  65
  66   <refsect1>
  67     <title>DESCRIPTION</title>
  68
  69     <para><function>lwres_gai_strerror()</function>
  70       returns an error message corresponding to an error code returned by
  71       <function>getaddrinfo()</function>.
  72       The following error codes and their meaning are defined in
  73       <filename>include/lwres/netdb.h</filename>.
  74       <variablelist>
  75         <varlistentry>
  76           <term><errorcode>EAI_ADDRFAMILY</errorcode></term>
  77           <listitem>
  78             <para>
  79               address family for hostname not supported
  80             </para>
  81           </listitem>
  82         </varlistentry>
  83         <varlistentry>
  84           <term><errorcode>EAI_AGAIN</errorcode></term>
  85           <listitem>
  86             <para>
  87               temporary failure in name resolution
  88             </para>
  89           </listitem>
  90         </varlistentry>
  91         <varlistentry>
  92           <term><errorcode>EAI_BADFLAGS</errorcode></term>
  93           <listitem>
  94             <para>
  95               invalid value for
  96               <constant>ai_flags</constant>
  97             </para>
  98           </listitem>
  99         </varlistentry>
 100         <varlistentry>
 101           <term><errorcode>EAI_FAIL</errorcode></term>
 102           <listitem>
 103             <para>
 104               non-recoverable failure in name resolution
 105             </para>
 106           </listitem>
 107         </varlistentry>
 108         <varlistentry>
 109           <term><errorcode>EAI_FAMILY</errorcode></term>
 110           <listitem>
 111             <para><constant>ai_family</constant> not supported
 112             </para>
 113           </listitem>
 114         </varlistentry>
 115         <varlistentry>
 116           <term><errorcode>EAI_MEMORY</errorcode></term>
 117           <listitem>
 118             <para>
 119               memory allocation failure
 120             </para>
 121           </listitem>
 122         </varlistentry>
 123         <varlistentry>
 124           <term><errorcode>EAI_NODATA</errorcode></term>
 125           <listitem>
 126             <para>
 127               no address associated with hostname
 128             </para>
 129           </listitem>
 130         </varlistentry>
 131         <varlistentry>
 132           <term><errorcode>EAI_NONAME</errorcode></term>
 133           <listitem>
 134             <para>
 135               hostname or servname not provided, or not known
 136             </para>
 137           </listitem>
 138         </varlistentry>
 139         <varlistentry>
 140           <term><errorcode>EAI_SERVICE</errorcode></term>
 141           <listitem>
 142             <para>
 143               servname not supported for <constant>ai_socktype</constant>
 144             </para>
 145           </listitem>
 146         </varlistentry>
 147         <varlistentry>
 148           <term><errorcode>EAI_SOCKTYPE</errorcode></term>
 149           <listitem>
 150             <para><constant>ai_socktype</constant> not supported
 151             </para>
 152           </listitem>
 153         </varlistentry>
 154         <varlistentry>
 155           <term><errorcode>EAI_SYSTEM</errorcode></term>
 156           <listitem>
 157             <para>
 158               system error returned in errno
 159             </para>
 160           </listitem>
 161         </varlistentry>
 162       </variablelist>
 163       The message <errorname>invalid error code</errorname> is returned if
 164       <parameter>ecode</parameter>
 165       is out of range.
 166     </para>
 167     <para><constant>ai_flags</constant>,
 168       <constant>ai_family</constant>
 169       and
 170       <constant>ai_socktype</constant>
 171       are elements of the
 172       <type>struct  addrinfo</type>
 173       used by
 174       <function>lwres_getaddrinfo()</function>.
 175     </para>
 176   </refsect1>
 177
 178   <refsect1>
 179     <title>SEE ALSO</title>
 180     <para><citerefentry>
 181         <refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum>
 182       </citerefentry>,
 183
 184       <citerefentry>
 185         <refentrytitle>lwres_getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
 186       </citerefentry>,
 187
 188       <citerefentry>
 189         <refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
 190       </citerefentry>,
 191
 192       <citerefentry>
 193         <refentrytitle>RFC2133</refentrytitle>
 194       </citerefentry>.
 195     </para>
 196   </refsect1>
 197 </refentry><!--
 198  - Local variables:
 199  - mode: sgml
 200  - End:
 201 -->