summaryrefslogtreecommitdiffstats
path: root/lib/lwres/man/lwres_gai_strerror.docbook
blob: c33fee5ea6cfe6b10bc0f28b36c6e5a4411a650e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
	       [<!ENTITY mdash "&#8212;">]>
<!--
 - Copyright (C) 2004, 2005, 2007  Internet Systems Consortium, Inc. ("ISC")
 - Copyright (C) 2000, 2001  Internet Software Consortium.
 -
 - Permission to use, copy, modify, and/or distribute this software for any
 - purpose with or without fee is hereby granted, provided that the above
 - copyright notice and this permission notice appear in all copies.
 -
 - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
 - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
 - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
 - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 - PERFORMANCE OF THIS SOFTWARE.
-->

<!-- $Id: lwres_gai_strerror.docbook,v 1.10 2007/06/18 23:47:51 tbox Exp $ -->
<refentry>

  <refentryinfo>
    <date>Jun 30, 2000</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>lwres_gai_strerror</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo>BIND9</refmiscinfo>
  </refmeta>

  <docinfo>
    <copyright>
      <year>2004</year>
      <year>2005</year>
      <year>2007</year>
      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
    </copyright>
    <copyright>
      <year>2000</year>
      <year>2001</year>
      <holder>Internet Software Consortium.</holder>
    </copyright>
  </docinfo>

  <refnamediv>
    <refname>lwres_gai_strerror</refname>
    <refpurpose>print suitable error string</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <funcsynopsis>
<funcsynopsisinfo>#include &lt;lwres/netdb.h&gt;</funcsynopsisinfo>
<funcprototype>
        <funcdef>
char *
<function>gai_strerror</function></funcdef>
        <paramdef>int <parameter>ecode</parameter></paramdef>
      </funcprototype>
</funcsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>DESCRIPTION</title>

    <para><function>lwres_gai_strerror()</function>
      returns an error message corresponding to an error code returned by
      <function>getaddrinfo()</function>.
      The following error codes and their meaning are defined in
      <filename>include/lwres/netdb.h</filename>.
      <variablelist>
        <varlistentry>
          <term><errorcode>EAI_ADDRFAMILY</errorcode></term>
          <listitem>
            <para>
              address family for hostname not supported
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_AGAIN</errorcode></term>
          <listitem>
            <para>
              temporary failure in name resolution
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_BADFLAGS</errorcode></term>
          <listitem>
            <para>
              invalid value for
              <constant>ai_flags</constant>
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_FAIL</errorcode></term>
          <listitem>
            <para>
              non-recoverable failure in name resolution
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_FAMILY</errorcode></term>
          <listitem>
            <para><constant>ai_family</constant> not supported
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_MEMORY</errorcode></term>
          <listitem>
            <para>
              memory allocation failure
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_NODATA</errorcode></term>
          <listitem>
            <para>
              no address associated with hostname
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_NONAME</errorcode></term>
          <listitem>
            <para>
              hostname or servname not provided, or not known
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_SERVICE</errorcode></term>
          <listitem>
            <para>
              servname not supported for <constant>ai_socktype</constant>
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_SOCKTYPE</errorcode></term>
          <listitem>
            <para><constant>ai_socktype</constant> not supported
            </para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><errorcode>EAI_SYSTEM</errorcode></term>
          <listitem>
            <para>
              system error returned in errno
            </para>
          </listitem>
        </varlistentry>
      </variablelist>
      The message <errorname>invalid error code</errorname> is returned if
      <parameter>ecode</parameter>
      is out of range.
    </para>
    <para><constant>ai_flags</constant>,
      <constant>ai_family</constant>
      and
      <constant>ai_socktype</constant>
      are elements of the
      <type>struct  addrinfo</type>
      used by
      <function>lwres_getaddrinfo()</function>.
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para><citerefentry>
        <refentrytitle>strerror</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>lwres_getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum>
      </citerefentry>,

      <citerefentry>
        <refentrytitle>RFC2133</refentrytitle>
      </citerefentry>.
    </para>
  </refsect1>
</refentry><!--
 - Local variables:
 - mode: sgml
 - End:
-->