lwres_gai_strerror.html [plain text]
<!--
- Copyright (C) 2000, 2001 Internet Software Consortium.
-
- Permission to use, copy, modify, and distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
- DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
- FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
- WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-->
<HTML
><HEAD
><TITLE
>lwres_gai_strerror</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.73
"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="AEN1"
>lwres_gai_strerror</A
></H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN8"
></A
><H2
>Name</H2
>gai_strerror -- print suitable error string</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN11"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN12"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include <lwres/netdb.h></PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>char *
gai_strerror</CODE
>(int ecode);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN18"
></A
><H2
>DESCRIPTION</H2
><P
><TT
CLASS="FUNCTION"
>lwres_gai_strerror()</TT
>
returns an error message corresponding to an error code returned by
<TT
CLASS="FUNCTION"
>getaddrinfo()</TT
>.
The following error codes and their meaning are defined in
<TT
CLASS="FILENAME"
>include/lwres/netdb.h</TT
>.
<P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_ADDRFAMILY</SPAN
></DT
><DD
><P
>address family for hostname not supported</P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_AGAIN</SPAN
></DT
><DD
><P
>temporary failure in name resolution</P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_BADFLAGS</SPAN
></DT
><DD
><P
>invalid value for
<TT
CLASS="CONSTANT"
>ai_flags</TT
></P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_FAIL</SPAN
></DT
><DD
><P
>non-recoverable failure in name resolution</P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_FAMILY</SPAN
></DT
><DD
><P
><TT
CLASS="CONSTANT"
>ai_family</TT
> not supported</P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_MEMORY</SPAN
></DT
><DD
><P
>memory allocation failure</P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_NODATA</SPAN
></DT
><DD
><P
>no address associated with hostname</P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_NONAME</SPAN
></DT
><DD
><P
>hostname or servname not provided, or not known</P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_SERVICE</SPAN
></DT
><DD
><P
>servname not supported for <TT
CLASS="CONSTANT"
>ai_socktype</TT
></P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_SOCKTYPE</SPAN
></DT
><DD
><P
><TT
CLASS="CONSTANT"
>ai_socktype</TT
> not supported</P
></DD
><DT
><SPAN
CLASS="ERRORCODE"
>EAI_SYSTEM</SPAN
></DT
><DD
><P
>system error returned in errno</P
></DD
></DL
></DIV
>
The message <SPAN
CLASS="ERRORNAME"
>invalid error code</SPAN
> is returned if
<TT
CLASS="PARAMETER"
><I
>ecode</I
></TT
>
is out of range.</P
><P
><TT
CLASS="CONSTANT"
>ai_flags</TT
>,
<TT
CLASS="CONSTANT"
>ai_family</TT
>
and
<TT
CLASS="CONSTANT"
>ai_socktype</TT
>
are elements of the
<SPAN
CLASS="TYPE"
>struct addrinfo</SPAN
>
used by
<TT
CLASS="FUNCTION"
>lwres_getaddrinfo()</TT
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN92"
></A
><H2
>SEE ALSO</H2
><P
><SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>strerror</SPAN
>(3)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>lwres_getaddrinfo</SPAN
>(3)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>getaddrinfo</SPAN
>(3)</SPAN
>,
<SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>RFC2133</SPAN
></SPAN
>.</P
></DIV
></BODY
></HTML
>