Merge from vendor branch BZIP:
[dragonfly.git] / contrib / bind-9.3 / lib / lwres / man / lwres_gai_strerror.html
1 <!--
2  - Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
3  - Copyright (C) 2000, 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 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.5.2.1.4.12 2006/06/29 13:02:31 marka 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.70.1">
23 </head>
24 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
25 <a name="id2482688"></a><div class="titlepage"></div>
26 <div class="refnamediv">
27 <h2>Name</h2>
28 <p>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 <p><code class="funcdef">
35 char *
36 <b class="fsfunc">gai_strerror</b>(</code>int ecode<code>)</code>;</p>
37 </div>
38 </div>
39 <div class="refsect1" lang="en">
40 <a name="id2549408"></a><h2>DESCRIPTION</h2>
41 <p>
42 <code class="function">lwres_gai_strerror()</code>
43 returns an error message corresponding to an error code returned by
44 <code class="function">getaddrinfo()</code>.
45 The following error codes and their meaning are defined in
46 <code class="filename">include/lwres/netdb.h</code>.
47 </p>
48 <div class="variablelist"><dl>
49 <dt><span class="term"><span class="errorcode">EAI_ADDRFAMILY</span></span></dt>
50 <dd><p>
51 address family for hostname not supported
52 </p></dd>
53 <dt><span class="term"><span class="errorcode">EAI_AGAIN</span></span></dt>
54 <dd><p>
55 temporary failure in name resolution
56 </p></dd>
57 <dt><span class="term"><span class="errorcode">EAI_BADFLAGS</span></span></dt>
58 <dd><p>
59 invalid value for
60 <code class="constant">ai_flags</code>
61 </p></dd>
62 <dt><span class="term"><span class="errorcode">EAI_FAIL</span></span></dt>
63 <dd><p>
64 non-recoverable failure in name resolution
65 </p></dd>
66 <dt><span class="term"><span class="errorcode">EAI_FAMILY</span></span></dt>
67 <dd><p>
68 <code class="constant">ai_family</code> not supported
69 </p></dd>
70 <dt><span class="term"><span class="errorcode">EAI_MEMORY</span></span></dt>
71 <dd><p>
72 memory allocation failure
73 </p></dd>
74 <dt><span class="term"><span class="errorcode">EAI_NODATA</span></span></dt>
75 <dd><p>
76 no address associated with hostname
77 </p></dd>
78 <dt><span class="term"><span class="errorcode">EAI_NONAME</span></span></dt>
79 <dd><p>
80 hostname or servname not provided, or not known
81 </p></dd>
82 <dt><span class="term"><span class="errorcode">EAI_SERVICE</span></span></dt>
83 <dd><p>
84 servname not supported for <code class="constant">ai_socktype</code>
85 </p></dd>
86 <dt><span class="term"><span class="errorcode">EAI_SOCKTYPE</span></span></dt>
87 <dd><p>
88 <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>
101 <code class="constant">ai_flags</code>,
102 <code class="constant">ai_family</code>
103 and
104 <code class="constant">ai_socktype</code>
105 are elements of the
106 <span class="type">struct  addrinfo</span>
107 used by
108 <code class="function">lwres_getaddrinfo()</code>.
109 </p>
110 </div>
111 <div class="refsect1" lang="en">
112 <a name="id2549605"></a><h2>SEE ALSO</h2>
113 <p>
114 <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>