Merge from vendor branch OPENSSH:
[dragonfly.git] / contrib / bind-9.2.4rc7 / lib / lwres / man / lwres_gai_strerror.3
1 .\" Copyright (C) 2004  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.2 2004/03/15 04:45:01 marka Exp $
17 .\"
18 .TH "LWRES_GAI_STRERROR" "3" "Jun 30, 2000" "BIND9" ""
19 .SH NAME
20 gai_strerror \- print suitable error string
21 .SH SYNOPSIS
22 \fB#include <lwres/netdb.h>
23 .sp
24 .na
25 char *
26 gai_strerror(int ecode);
27 .ad
28 \fR
29 .SH "DESCRIPTION"
30 .PP
31 \fBlwres_gai_strerror()\fR
32 returns an error message corresponding to an error code returned by
33 \fBgetaddrinfo()\fR.
34 The following error codes and their meaning are defined in
35 \fIinclude/lwres/netdb.h\fR.
36 .TP
37 \fBEAI_ADDRFAMILY\fR
38 address family for hostname not supported
39 .TP
40 \fBEAI_AGAIN\fR
41 temporary failure in name resolution
42 .TP
43 \fBEAI_BADFLAGS\fR
44 invalid value for
45 ai_flags
46 .TP
47 \fBEAI_FAIL\fR
48 non-recoverable failure in name resolution
49 .TP
50 \fBEAI_FAMILY\fR
51 ai_family not supported
52 .TP
53 \fBEAI_MEMORY\fR
54 memory allocation failure
55 .TP
56 \fBEAI_NODATA\fR
57 no address associated with hostname
58 .TP
59 \fBEAI_NONAME\fR
60 hostname or servname not provided, or not known
61 .TP
62 \fBEAI_SERVICE\fR
63 servname not supported for ai_socktype
64 .TP
65 \fBEAI_SOCKTYPE\fR
66 ai_socktype not supported
67 .TP
68 \fBEAI_SYSTEM\fR
69 system error returned in errno
70 .PP
71 The message \fBinvalid error code\fR is returned if
72 \fIecode\fR
73 is out of range.
74 .PP
75 ai_flags,
76 ai_family
77 and
78 ai_socktype
79 are elements of the
80 \fBstruct addrinfo\fR
81 used by
82 \fBlwres_getaddrinfo()\fR.
83 .SH "SEE ALSO"
84 .PP
85 \fBstrerror\fR(3),
86 \fBlwres_getaddrinfo\fR(3),
87 \fBgetaddrinfo\fR(3),
88 \fBRFC2133\fR.