lib/liblwres/man/lwres_gai_strerror.docbook

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