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  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: lwres_gai_strerror.docbook,v 1.10 2007/06/18 23:47:51 tbox Exp $ -->
  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       <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
  40     </copyright>
  41     <copyright>
  42       <year>2000</year>
  43       <year>2001</year>
  44       <holder>Internet Software Consortium.</holder>
  45     </copyright>
  46   </docinfo>
  47
  48   <refnamediv>
  49     <refname>lwres_gai_strerror</refname>
  50     <refpurpose>print suitable error string</refpurpose>
  51   </refnamediv>
  52
  53   <refsynopsisdiv>
  54     <funcsynopsis>
  55 <funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
  56 <funcprototype>
  57         <funcdef>
  58 char *
  59 <function>gai_strerror</function></funcdef>
  60         <paramdef>int <parameter>ecode</parameter></paramdef>
  61       </funcprototype>
  62 </funcsynopsis>
  63   </refsynopsisdiv>
  64
  65   <refsect1>
  66     <title>DESCRIPTION</title>
  67
  68     <para><function>lwres_gai_strerror()</function>
  69       returns an error message corresponding to an error code returned by
  70       <function>getaddrinfo()</function>.
  71       The following error codes and their meaning are defined in
  72       <filename>include/lwres/netdb.h</filename>.
  73       <variablelist>
  74         <varlistentry>
  75           <term><errorcode>EAI_ADDRFAMILY</errorcode></term>
  76           <listitem>
  77             <para>
  78               address family for hostname not supported
  79             </para>
  80           </listitem>
  81         </varlistentry>
  82         <varlistentry>
  83           <term><errorcode>EAI_AGAIN</errorcode></term>
  84           <listitem>
  85             <para>
  86               temporary failure in name resolution
  87             </para>
  88           </listitem>
  89         </varlistentry>
  90         <varlistentry>
  91           <term><errorcode>EAI_BADFLAGS</errorcode></term>
  92           <listitem>
  93             <para>
  94               invalid value for
  95               <constant>ai_flags</constant>
  96             </para>
  97           </listitem>
  98         </varlistentry>
  99         <varlistentry>
 100           <term><errorcode>EAI_FAIL</errorcode></term>
 101           <listitem>
 102             <para>
 103               non-recoverable failure in name resolution
 104             </para>
 105           </listitem>
 106         </varlistentry>
 107         <varlistentry>
 108           <term><errorcode>EAI_FAMILY</errorcode></term>
 109           <listitem>
 110             <para><constant>ai_family</constant> not supported
 111             </para>
 112           </listitem>
 113         </varlistentry>
 114         <varlistentry>
 115           <term><errorcode>EAI_MEMORY</errorcode></term>
 116           <listitem>
 117             <para>
 118               memory allocation failure
 119             </para>
 120           </listitem>
 121         </varlistentry>
 122         <varlistentry>
 123           <term><errorcode>EAI_NODATA</errorcode></term>
 124           <listitem>
 125             <para>
 126               no address associated with hostname
 127             </para>
 128           </listitem>
 129         </varlistentry>
 130         <varlistentry>
 131           <term><errorcode>EAI_NONAME</errorcode></term>
 132           <listitem>
 133             <para>
 134               hostname or servname not provided, or not known
 135             </para>
 136           </listitem>
 137         </varlistentry>
 138         <varlistentry>
 139           <term><errorcode>EAI_SERVICE</errorcode></term>
 140           <listitem>
 141             <para>
 142               servname not supported for <constant>ai_socktype</constant>
 143             </para>
 144           </listitem>
 145         </varlistentry>
 146         <varlistentry>
 147           <term><errorcode>EAI_SOCKTYPE</errorcode></term>
 148           <listitem>
 149             <para><constant>ai_socktype</constant> not supported
 150             </para>
 151           </listitem>
 152         </varlistentry>
 153         <varlistentry>
 154           <term><errorcode>EAI_SYSTEM</errorcode></term>
 155           <listitem>
 156             <para>
 157               system error returned in errno
 158             </para>
 159           </listitem>
 160         </varlistentry>
 161       </variablelist>
 162       The message <errorname>invalid error code</errorname> is returned if
 163       <parameter>ecode</parameter>
 164       is out of range.
 165     </para>
 166     <para><constant>ai_flags</constant>,
 167       <constant>ai_family</constant>
 168       and
 169       <constant>ai_socktype</constant>
 170       are elements of the
 171       <type>struct  addrinfo</type>
 172       used by
 173       <function>lwres_getaddrinfo()</function>.
 174     </para>
 175   </refsect1>
 176
 177   <refsect1>
 178     <title>SEE ALSO</title>
 179     <para><citerefentry>
 180         <refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum>
 181       </citerefentry>,
 182
 183       <citerefentry>
 184         <refentrytitle>lwres_getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
 185       </citerefentry>,
 186
 187       <citerefentry>
 188         <refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
 189       </citerefentry>,
 190
 191       <citerefentry>
 192         <refentrytitle>RFC2133</refentrytitle>
 193       </citerefentry>.
 194     </para>
 195   </refsect1>
 196 </refentry><!--
 197  - Local variables:
 198  - mode: sgml
 199  - End:
 200 -->