|
Packit |
7cfc04 |
'\" et
|
|
Packit |
7cfc04 |
.TH GAI_STRERROR "3P" 2013 "IEEE/The Open Group" "POSIX Programmer's Manual"
|
|
Packit |
7cfc04 |
.SH PROLOG
|
|
Packit |
7cfc04 |
This manual page is part of the POSIX Programmer's Manual.
|
|
Packit |
7cfc04 |
The Linux implementation of this interface may differ (consult
|
|
Packit |
7cfc04 |
the corresponding Linux manual page for details of Linux behavior),
|
|
Packit |
7cfc04 |
or the interface may not be implemented on Linux.
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
.SH NAME
|
|
Packit |
7cfc04 |
gai_strerror
|
|
Packit |
7cfc04 |
\(em address and name information error description
|
|
Packit |
7cfc04 |
.SH SYNOPSIS
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
#include <netdb.h>
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
const char *gai_strerror(int \fIecode\fP);
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
.SH DESCRIPTION
|
|
Packit |
7cfc04 |
The
|
|
Packit |
7cfc04 |
\fIgai_strerror\fR()
|
|
Packit |
7cfc04 |
function shall return a text string describing an error value for the
|
|
Packit |
7cfc04 |
\fIgetaddrinfo\fR()
|
|
Packit |
7cfc04 |
and
|
|
Packit |
7cfc04 |
\fIgetnameinfo\fR()
|
|
Packit |
7cfc04 |
functions listed in the
|
|
Packit |
7cfc04 |
.IR <netdb.h>
|
|
Packit |
7cfc04 |
header.
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
When the
|
|
Packit |
7cfc04 |
.IR ecode
|
|
Packit |
7cfc04 |
argument is one of the following values listed in the
|
|
Packit |
7cfc04 |
.IR <netdb.h>
|
|
Packit |
7cfc04 |
header:
|
|
Packit |
7cfc04 |
.TS
|
|
Packit |
7cfc04 |
tab(!);
|
|
Packit |
7cfc04 |
le le.
|
|
Packit |
7cfc04 |
T{
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
.BR [EAI_AGAIN]
|
|
Packit |
7cfc04 |
.BR [EAI_BADFLAGS]
|
|
Packit |
7cfc04 |
.BR [EAI_FAIL]
|
|
Packit |
7cfc04 |
.BR [EAI_FAMILY]
|
|
Packit |
7cfc04 |
.BR [EAI_MEMORY]
|
|
Packit |
7cfc04 |
T}!T{
|
|
Packit |
7cfc04 |
.nf
|
|
Packit |
7cfc04 |
.BR [EAI_NONAME]
|
|
Packit |
7cfc04 |
.BR [EAI_OVERFLOW]
|
|
Packit |
7cfc04 |
.BR [EAI_SERVICE]
|
|
Packit |
7cfc04 |
.BR [EAI_SOCKTYPE]
|
|
Packit |
7cfc04 |
.BR [EAI_SYSTEM]
|
|
Packit |
7cfc04 |
.fi
|
|
Packit |
7cfc04 |
T}
|
|
Packit |
7cfc04 |
.TE
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
the function return value shall point to a string describing the error.
|
|
Packit |
7cfc04 |
If the argument is not one of those values, the function shall return a
|
|
Packit |
7cfc04 |
pointer to a string whose contents indicate an unknown error.
|
|
Packit |
7cfc04 |
.SH "RETURN VALUE"
|
|
Packit |
7cfc04 |
Upon successful completion,
|
|
Packit |
7cfc04 |
\fIgai_strerror\fR()
|
|
Packit |
7cfc04 |
shall return a pointer to an implementation-defined string.
|
|
Packit |
7cfc04 |
.SH "ERRORS"
|
|
Packit |
7cfc04 |
No errors are defined.
|
|
Packit |
7cfc04 |
.LP
|
|
Packit |
7cfc04 |
.IR "The following sections are informative."
|
|
Packit |
7cfc04 |
.SH EXAMPLES
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "APPLICATION USAGE"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH RATIONALE
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "FUTURE DIRECTIONS"
|
|
Packit |
7cfc04 |
None.
|
|
Packit |
7cfc04 |
.SH "SEE ALSO"
|
|
Packit |
7cfc04 |
.IR "\fIfreeaddrinfo\fR\^(\|)"
|
|
Packit |
7cfc04 |
.P
|
|
Packit |
7cfc04 |
The Base Definitions volume of POSIX.1\(hy2008,
|
|
Packit |
7cfc04 |
.IR "\fB<netdb.h>\fP"
|
|
Packit |
7cfc04 |
.SH COPYRIGHT
|
|
Packit |
7cfc04 |
Portions of this text are reprinted and reproduced in electronic form
|
|
Packit |
7cfc04 |
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
|
|
Packit |
7cfc04 |
-- Portable Operating System Interface (POSIX), The Open Group Base
|
|
Packit |
7cfc04 |
Specifications Issue 7, Copyright (C) 2013 by the Institute of
|
|
Packit |
7cfc04 |
Electrical and Electronics Engineers, Inc and The Open Group.
|
|
Packit |
7cfc04 |
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
|
|
Packit |
7cfc04 |
event of any discrepancy between this version and the original IEEE and
|
|
Packit |
7cfc04 |
The Open Group Standard, the original IEEE and The Open Group Standard
|
|
Packit |
7cfc04 |
is the referee document. The original Standard can be obtained online at
|
|
Packit |
7cfc04 |
http://www.unix.org/online.html .
|
|
Packit |
7cfc04 |
|
|
Packit |
7cfc04 |
Any typographical or formatting errors that appear
|
|
Packit |
7cfc04 |
in this page are most likely
|
|
Packit |
7cfc04 |
to have been introduced during the conversion of the source files to
|
|
Packit |
7cfc04 |
man page format. To report such errors, see
|
|
Packit |
7cfc04 |
https://www.kernel.org/doc/man-pages/reporting_bugs.html .
|