gai_strerror(3p) — Linux manual page

GAI_STRERROR(3P)        POSIX Programmer's Manual       GAI_STRERROR(3P)

PROLOG         top

       This manual page is part of the POSIX Programmer's Manual.  The
       Linux implementation of this interface may differ (consult the
       corresponding Linux manual page for details of Linux behavior),
       or the interface may not be implemented on Linux.

NAME         top

       gai_strerror — address and name information error description

SYNOPSIS         top

       #include <netdb.h>

       const char *gai_strerror(int ecode);

DESCRIPTION         top

       The gai_strerror() function shall return a text string describing
       an error value for the getaddrinfo() and getnameinfo() functions
       listed in the <netdb.h> header.

       When the ecode argument is one of the following values listed in
       the <netdb.h> header:
       [EAI_AGAIN]      [EAI_NONAME]
       [EAI_BADFLAGS]   [EAI_OVERFLOW]
       [EAI_FAIL]       [EAI_SERVICE]
       [EAI_FAMILY]     [EAI_SOCKTYPE]
       [EAI_MEMORY]     [EAI_SYSTEM]

       the function return value shall point to a string describing the
       error.  If the argument is not one of those values, the function
       shall return a pointer to a string whose contents indicate an
       unknown error.

RETURN VALUE         top

       Upon successful completion, gai_strerror() shall return a pointer
       to an implementation-defined string.

ERRORS         top

       No errors are defined.

       The following sections are informative.

EXAMPLES         top

       None.

APPLICATION USAGE         top

       None.

RATIONALE         top

       None.

FUTURE DIRECTIONS         top

       None.

SEE ALSO         top

       freeaddrinfo(3p)

       The Base Definitions volume of POSIX.1‐2017, netdb.h(0p)

COPYRIGHT         top

       Portions of this text are reprinted and reproduced in electronic
       form from IEEE Std 1003.1-2017, Standard for Information
       Technology -- Portable Operating System Interface (POSIX), The
       Open Group Base Specifications Issue 7, 2018 Edition, Copyright
       (C) 2018 by the Institute of Electrical and Electronics
       Engineers, Inc and The Open Group.  In the event of any
       discrepancy between this version and the original IEEE and The
       Open Group Standard, the original IEEE and The Open Group
       Standard is the referee document. The original Standard can be
       obtained online at http://www.opengroup.org/unix/online.html .

       Any typographical or formatting errors that appear in this page
       are most likely to have been introduced during the conversion of
       the source files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .

IEEE/The Open Group               2017                  GAI_STRERROR(3P)

Pages that refer to this page: netdb.h(0p),  freeaddrinfo(3p),  getnameinfo(3p)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.