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

   1 <!--
   2  - Copyright (C) 2004, 2005, 2007, 2014, 2015 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 <html>
  18 <head>
  19 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  20 <title>lwres_gai_strerror</title>
  21 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
  22 </head>
  23 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry">
  24 <a name="id-1"></a><div class="titlepage"></div>
  25 <div class="refnamediv">
  26 <h2>Name</h2>
  27 <p>lwres_gai_strerror &#8212; print suitable error string</p>
  28 </div>
  29 <div class="refsynopsisdiv">
  30 <h2>Synopsis</h2>
  31 <div class="funcsynopsis">
  32 <pre class="funcsynopsisinfo">#include &lt;lwres/netdb.h&gt;</pre>
  33 <table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr>
  34 <td><code class="funcdef">
  35 char *
  36 <b class="fsfunc">gai_strerror</b>(</code></td>
  37 <td>int <var class="pdparam">ecode</var><code>)</code>;</td>
  38 </tr></table>
  39 <div class="funcprototype-spacer"> </div>
  40 </div>
  41 </div>
  42 <div class="refsection">
  43 <a name="id-1.7"></a><h2>DESCRIPTION</h2>
  44 <p><code class="function">lwres_gai_strerror()</code>
  45       returns an error message corresponding to an error code returned by
  46       <code class="function">getaddrinfo()</code>.
  47       The following error codes and their meaning are defined in
  48       <code class="filename">include/lwres/netdb.h</code>.
  49       </p>
  50 <div class="variablelist"><dl class="variablelist">
  51 <dt><span class="term"><span class="errorcode">EAI_ADDRFAMILY</span></span></dt>
  52 <dd><p>
  53               address family for hostname not supported
  54             </p></dd>
  55 <dt><span class="term"><span class="errorcode">EAI_AGAIN</span></span></dt>
  56 <dd><p>
  57               temporary failure in name resolution
  58             </p></dd>
  59 <dt><span class="term"><span class="errorcode">EAI_BADFLAGS</span></span></dt>
  60 <dd><p>
  61               invalid value for
  62               <code class="constant">ai_flags</code>
  63             </p></dd>
  64 <dt><span class="term"><span class="errorcode">EAI_FAIL</span></span></dt>
  65 <dd><p>
  66               non-recoverable failure in name resolution
  67             </p></dd>
  68 <dt><span class="term"><span class="errorcode">EAI_FAMILY</span></span></dt>
  69 <dd><p><code class="constant">ai_family</code> not supported
  70             </p></dd>
  71 <dt><span class="term"><span class="errorcode">EAI_MEMORY</span></span></dt>
  72 <dd><p>
  73               memory allocation failure
  74             </p></dd>
  75 <dt><span class="term"><span class="errorcode">EAI_NODATA</span></span></dt>
  76 <dd><p>
  77               no address associated with hostname
  78             </p></dd>
  79 <dt><span class="term"><span class="errorcode">EAI_NONAME</span></span></dt>
  80 <dd><p>
  81               hostname or servname not provided, or not known
  82             </p></dd>
  83 <dt><span class="term"><span class="errorcode">EAI_SERVICE</span></span></dt>
  84 <dd><p>
  85               servname not supported for <code class="constant">ai_socktype</code>
  86             </p></dd>
  87 <dt><span class="term"><span class="errorcode">EAI_SOCKTYPE</span></span></dt>
  88 <dd><p><code class="constant">ai_socktype</code> not supported
  89             </p></dd>
  90 <dt><span class="term"><span class="errorcode">EAI_SYSTEM</span></span></dt>
  91 <dd><p>
  92               system error returned in errno
  93             </p></dd>
  94 </dl></div>
  95 <p>
  96       The message <span class="errorname">invalid error code</span> is returned if
  97       <em class="parameter"><code>ecode</code></em>
  98       is out of range.
  99     </p>
 100 <p><code class="constant">ai_flags</code>,
 101       <code class="constant">ai_family</code>
 102       and
 103       <code class="constant">ai_socktype</code>
 104       are elements of the
 105       <span class="type">struct  addrinfo</span>
 106       used by
 107       <code class="function">lwres_getaddrinfo()</code>.
 108     </p>
 109 </div>
 110 <div class="refsection">
 111 <a name="id-1.8"></a><h2>SEE ALSO</h2>
 112 <p><span class="citerefentry"><span class="refentrytitle">strerror</span>(3)</span>,
 113
 114       <span class="citerefentry"><span class="refentrytitle">lwres_getaddrinfo</span>(3)</span>,
 115
 116       <span class="citerefentry"><span class="refentrytitle">getaddrinfo</span>(3)</span>,
 117
 118       <span class="citerefentry"><span class="refentrytitle">RFC2133</span></span>.
 119     </p>
 120 </div>
 121 </div></body>
 122 </html>