Merge from vendor branch FILE:
[dragonfly.git] / contrib / bind-9.3 / lib / lwres / man / lwres_gai_strerror.3
1 .\" Copyright (C) 2004, 2005 Internet Systems Consortium, Inc. ("ISC")
2 .\" Copyright (C) 2000, 2001 Internet Software Consortium.
3 .\" 
4 .\" Permission to use, copy, modify, and distribute this software for any
5 .\" purpose with or without fee is hereby granted, provided that the above
6 .\" copyright notice and this permission notice appear in all copies.
7 .\" 
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
9 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10 .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14 .\" PERFORMANCE OF THIS SOFTWARE.
15 .\"
16 .\" $Id: lwres_gai_strerror.3,v 1.13.2.1.8.5 2005/10/13 02:33:52 marka Exp $
17 .\"
18 .hy 0
19 .ad l
20 .\" ** You probably do not want to edit this file directly **
21 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
22 .\" Instead of manually editing it, you probably should edit the DocBook XML
23 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
24 .TH "LWRES_GAI_STRERROR" "3" "Jun 30, 2000" "BIND9" "BIND9"
25 .\" disable hyphenation
26 .nh
27 .\" disable justification (adjust text to left margin only)
28 .ad l
29 .SH "NAME"
30 gai_strerror \- print suitable error string
31 .SH "SYNOPSIS"
32 .nf
33 #include <lwres/netdb.h>
34 .fi
35 .HP 20
36 \fBchar\ *\ \fBgai_strerror\fR\fR\fB(\fR\fBint\ ecode\fR\fB);\fR
37 .SH "DESCRIPTION"
38 .PP
39 \fBlwres_gai_strerror()\fR
40 returns an error message corresponding to an error code returned by
41 \fBgetaddrinfo()\fR. The following error codes and their meaning are defined in
42 \fIinclude/lwres/netdb.h\fR.
43 .TP
44 \fBEAI_ADDRFAMILY\fR
45 address family for hostname not supported
46 .TP
47 \fBEAI_AGAIN\fR
48 temporary failure in name resolution
49 .TP
50 \fBEAI_BADFLAGS\fR
51 invalid value for
52 \fBai_flags\fR
53 .TP
54 \fBEAI_FAIL\fR
55 non\-recoverable failure in name resolution
56 .TP
57 \fBEAI_FAMILY\fR
58 \fBai_family\fR
59 not supported
60 .TP
61 \fBEAI_MEMORY\fR
62 memory allocation failure
63 .TP
64 \fBEAI_NODATA\fR
65 no address associated with hostname
66 .TP
67 \fBEAI_NONAME\fR
68 hostname or servname not provided, or not known
69 .TP
70 \fBEAI_SERVICE\fR
71 servname not supported for
72 \fBai_socktype\fR
73 .TP
74 \fBEAI_SOCKTYPE\fR
75 \fBai_socktype\fR
76 not supported
77 .TP
78 \fBEAI_SYSTEM\fR
79 system error returned in errno
80 The message
81 invalid error code
82 is returned if
83 \fIecode\fR
84 is out of range.
85 .PP
86 \fBai_flags\fR,
87 \fBai_family\fR
88 and
89 \fBai_socktype\fR
90 are elements of the
91 \fBstruct addrinfo\fR
92 used by
93 \fBlwres_getaddrinfo()\fR.
94 .SH "SEE ALSO"
95 .PP
96 \fBstrerror\fR(3),
97 \fBlwres_getaddrinfo\fR(3),
98 \fBgetaddrinfo\fR(3),
99 \fBRFC2133\fR().