man pages section 3: Basic Library Functions

gai_strerror (3C)

Name

gai_strerror - address and name information error description

Synopsis

#include <netdb.h>

const char *gai_strerror(int ecode);

Description

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

When the ecode argument is one of the following values listed in the <netdb.h> header:

• EAI_ADDRFAMILY

• EAI_AGAIN

• EAI_BADFLAGS

• EAI_FAIL

• EAI_FAMILY

• EAI_MEMORY

• EAI_NODATA

• EAI_NONAME

• EAI_SERVICE

• EAI_SOCKTYPE

• EAI_SYSTEM

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

Return Values

Upon successful completion, gai_strerror() returns a pointer to a string describing the error value.

Errors

No errors are defined.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE Interface Stability Committed MT-Level MT-Safe Standard See standards(7).

See Also

getaddrinfo(3C), getnameinfo(3C), attributes(7), standards(7)

Gilligan, R. RFC 3493, Basic Socket Interface Extensions for IPv6. Network Working Group. February 2003. https://tools.ietf.org/html/rfc3493

History

The gai_strerror() function was added to Oracle Solaris in the Solaris 8 release.