contrib/bind/lib/lwres/man/lwres_gai_strerror.html

   1 <!--
   2  - Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2000, 2001 Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and/or 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 ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17 <!-- $Id: lwres_gai_strerror.html,v 1.24.214.1.2.1 2009/12/31 23:47:14 tbox Exp $ -->
  18 <html>
  19 <head>
  20 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  21 <title>lwres_gai_strerror</title>
  22 <meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
  23 </head>
  24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
  25 <a name="id2476267"></a><div class="titlepage"></div>
  26 <div class="refnamediv">
  27 <h2>Name</h2>
  28 <p>lwres_gai_strerror &#8212; print suitable error string</p>
  29 </div>
  30 <div class="refsynopsisdiv">
  31 <h2>Synopsis</h2>
  32 <div class="funcsynopsis">
  33 <pre class="funcsynopsisinfo">#include &lt;lwres/netdb.h&gt;</pre>
  34 <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr>
  35 <td><code class="funcdef">
  36 char *
  37 <b class="fsfunc">gai_strerror</b>(</code></td>
  38 <td>int  </td>
  39 <td>
  40 <var class="pdparam">ecode</var><code>)</code>;</td>
  41 </tr></table>
  42 </div>
  43 </div>
  44 <div class="refsect1" lang="en">
  45 <a name="id2543358"></a><h2>DESCRIPTION</h2>
  46 <p><code class="function">lwres_gai_strerror()</code>
  47       returns an error message corresponding to an error code returned by
  48       <code class="function">getaddrinfo()</code>.
  49       The following error codes and their meaning are defined in
  50       <code class="filename">include/lwres/netdb.h</code>.
  51       </p>
  52 <div class="variablelist"><dl>
  53 <dt><span class="term"><span class="errorcode">EAI_ADDRFAMILY</span></span></dt>
  54 <dd><p>
  55               address family for hostname not supported
  56             </p></dd>
  57 <dt><span class="term"><span class="errorcode">EAI_AGAIN</span></span></dt>
  58 <dd><p>
  59               temporary failure in name resolution
  60             </p></dd>
  61 <dt><span class="term"><span class="errorcode">EAI_BADFLAGS</span></span></dt>
  62 <dd><p>
  63               invalid value for
  64               <code class="constant">ai_flags</code>
  65             </p></dd>
  66 <dt><span class="term"><span class="errorcode">EAI_FAIL</span></span></dt>
  67 <dd><p>
  68               non-recoverable failure in name resolution
  69             </p></dd>
  70 <dt><span class="term"><span class="errorcode">EAI_FAMILY</span></span></dt>
  71 <dd><p><code class="constant">ai_family</code> not supported
  72             </p></dd>
  73 <dt><span class="term"><span class="errorcode">EAI_MEMORY</span></span></dt>
  74 <dd><p>
  75               memory allocation failure
  76             </p></dd>
  77 <dt><span class="term"><span class="errorcode">EAI_NODATA</span></span></dt>
  78 <dd><p>
  79               no address associated with hostname
  80             </p></dd>
  81 <dt><span class="term"><span class="errorcode">EAI_NONAME</span></span></dt>
  82 <dd><p>
  83               hostname or servname not provided, or not known
  84             </p></dd>
  85 <dt><span class="term"><span class="errorcode">EAI_SERVICE</span></span></dt>
  86 <dd><p>
  87               servname not supported for <code class="constant">ai_socktype</code>
  88             </p></dd>
  89 <dt><span class="term"><span class="errorcode">EAI_SOCKTYPE</span></span></dt>
  90 <dd><p><code class="constant">ai_socktype</code> not supported
  91             </p></dd>
  92 <dt><span class="term"><span class="errorcode">EAI_SYSTEM</span></span></dt>
  93 <dd><p>
  94               system error returned in errno
  95             </p></dd>
  96 </dl></div>
  97 <p>
  98       The message <span class="errorname">invalid error code</span> is returned if
  99       <em class="parameter"><code>ecode</code></em>
 100       is out of range.
 101     </p>
 102 <p><code class="constant">ai_flags</code>,
 103       <code class="constant">ai_family</code>
 104       and
 105       <code class="constant">ai_socktype</code>
 106       are elements of the
 107       <span class="type">struct  addrinfo</span>
 108       used by
 109       <code class="function">lwres_getaddrinfo()</code>.
 110     </p>
 111 </div>
 112 <div class="refsect1" lang="en">
 113 <a name="id2543574"></a><h2>SEE ALSO</h2>
 114 <p><span class="citerefentry"><span class="refentrytitle">strerror</span>(3)</span>,
 115
 116       <span class="citerefentry"><span class="refentrytitle">lwres_getaddrinfo</span>(3)</span>,
 117
 118       <span class="citerefentry"><span class="refentrytitle">getaddrinfo</span>(3)</span>,
 119
 120       <span class="citerefentry"><span class="refentrytitle">RFC2133</span></span>.
 121     </p>
 122 </div>
 123 </div></body>
 124 </html>