xref: /freebsd/lib/libc/net/gai_strerror.3 (revision b0d29bc47dba79f6f38e67eabadfb4b32ffd9390)
1.\"	$KAME: gai_strerror.3,v 1.1 2005/01/05 03:04:47 itojun Exp $
2.\"	$OpenBSD: gai_strerror.3,v 1.4 2004/12/20 23:04:53 millert Exp $
3.\"
4.\" Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
5.\" Copyright (C) 2000, 2001  Internet Software Consortium.
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
12.\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
13.\" AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
14.\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
15.\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
16.\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17.\" PERFORMANCE OF THIS SOFTWARE.
18.\"
19.\" $FreeBSD$
20.\"
21.Dd December 23, 2018
22.Dt GAI_STRERROR 3
23.Os
24.Sh NAME
25.Nm gai_strerror
26.Nd get error message string from EAI_xxx error code
27.Sh SYNOPSIS
28.In sys/types.h
29.In sys/socket.h
30.In netdb.h
31.Ft "const char *"
32.Fn gai_strerror "int ecode"
33.Sh DESCRIPTION
34The
35.Fn gai_strerror
36function returns an error message string corresponding to the error code
37returned by
38.Xr getaddrinfo 3
39or
40.Xr getnameinfo 3 .
41.Pp
42The following error codes and their meaning are defined in
43.In netdb.h :
44.Pp
45.Bl -tag -width ".Dv EAI_BADFLAGS" -offset indent -compact
46.It Dv EAI_AGAIN
47Name could not be resolved at this time
48.It Dv EAI_BADFLAGS
49flags parameter had an invalid value
50.It Dv EAI_BADHINTS
51invalid value for
52.Fa hints
53.It Dv EAI_FAIL
54Non-recoverable failure in name resolution
55.It Dv EAI_FAMILY
56Address family was not recognized
57.It Dv EAI_MEMORY
58Memory allocation failure
59.It Dv EAI_NONAME
60Name does not resolve
61.It Dv EAI_OVERFLOW
62argument buffer overflow
63.It Dv EAI_PROTOCOL
64Resolved protocol is unknown
65.It Dv EAI_SERVICE
66Service was not recognized for socket type
67.It Dv EAI_SOCKTYPE
68Intended socket type was not recognized
69.It Dv EAI_SYSTEM
70System error returned in
71.Va errno
72.El
73.Sh RETURN VALUES
74The
75.Fn gai_strerror
76function
77returns a pointer to the error message string corresponding to
78.Fa ecode .
79If
80.Fa ecode
81is out of range, an implementation-specific error message string is returned.
82.Sh SEE ALSO
83.Xr getaddrinfo 3 ,
84.Xr getnameinfo 3
85.Sh STANDARDS
86.Bl -tag -width ".It RFC 2743"
87.It RFC 3493
88Basic Socket Interface Extensions for IPv6
89.El
90