contrib/bind9/lib/lwres/man/lwres_gai_strerror.html

   1 <!--
   2  - Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  - Copyright (C) 2001  Internet Software Consortium.
   4  -
   5  - Permission to use, copy, modify, and distribute this software for any
   6  - purpose with or without fee is hereby granted, provided that the above
   7  - copyright notice and this permission notice appear in all copies.
   8  -
   9  - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  - PERFORMANCE OF THIS SOFTWARE.
  16 -->
  17
  18 <!-- $Id: lwres_gai_strerror.html,v 1.5.2.1.4.2 2004/08/22 23:39:03 marka Exp $ -->
  19
  20 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  21 <HTML
  22 ><HEAD
  23 ><TITLE
  24 >lwres_gai_strerror</TITLE
  25 ><META
  26 NAME="GENERATOR"
  27 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
  28 ><BODY
  29 CLASS="REFENTRY"
  30 BGCOLOR="#FFFFFF"
  31 TEXT="#000000"
  32 LINK="#0000FF"
  33 VLINK="#840084"
  34 ALINK="#0000FF"
  35 ><H1
  36 ><A
  37 NAME="AEN1"
  38 ></A
  39 >lwres_gai_strerror</H1
  40 ><DIV
  41 CLASS="REFNAMEDIV"
  42 ><A
  43 NAME="AEN8"
  44 ></A
  45 ><H2
  46 >Name</H2
  47 >gai_strerror&nbsp;--&nbsp;print suitable error string</DIV
  48 ><DIV
  49 CLASS="REFSYNOPSISDIV"
  50 ><A
  51 NAME="AEN11"
  52 ></A
  53 ><H2
  54 >Synopsis</H2
  55 ><DIV
  56 CLASS="FUNCSYNOPSIS"
  57 ><P
  58 ></P
  59 ><A
  60 NAME="AEN12"
  61 ></A
  62 ><PRE
  63 CLASS="FUNCSYNOPSISINFO"
  64 >#include &lt;lwres/netdb.h&gt;</PRE
  65 ><P
  66 ><CODE
  67 ><CODE
  68 CLASS="FUNCDEF"
  69 >char *
  70 gai_strerror</CODE
  71 >(int ecode);</CODE
  72 ></P
  73 ><P
  74 ></P
  75 ></DIV
  76 ></DIV
  77 ><DIV
  78 CLASS="REFSECT1"
  79 ><A
  80 NAME="AEN18"
  81 ></A
  82 ><H2
  83 >DESCRIPTION</H2
  84 ><P
  85 ><CODE
  86 CLASS="FUNCTION"
  87 >lwres_gai_strerror()</CODE
  88 >
  89 returns an error message corresponding to an error code returned by
  90 <CODE
  91 CLASS="FUNCTION"
  92 >getaddrinfo()</CODE
  93 >.
  94 The following error codes and their meaning are defined in
  95 <TT
  96 CLASS="FILENAME"
  97 >include/lwres/netdb.h</TT
  98 >.
  99 <P
 100 ></P
 101 ><DIV
 102 CLASS="VARIABLELIST"
 103 ><DL
 104 ><DT
 105 ><SPAN
 106 CLASS="ERRORCODE"
 107 >EAI_ADDRFAMILY</SPAN
 108 ></DT
 109 ><DD
 110 ><P
 111 >address family for hostname not supported</P
 112 ></DD
 113 ><DT
 114 ><SPAN
 115 CLASS="ERRORCODE"
 116 >EAI_AGAIN</SPAN
 117 ></DT
 118 ><DD
 119 ><P
 120 >temporary failure in name resolution</P
 121 ></DD
 122 ><DT
 123 ><SPAN
 124 CLASS="ERRORCODE"
 125 >EAI_BADFLAGS</SPAN
 126 ></DT
 127 ><DD
 128 ><P
 129 >invalid value for
 130 <CODE
 131 CLASS="CONSTANT"
 132 >ai_flags</CODE
 133 ></P
 134 ></DD
 135 ><DT
 136 ><SPAN
 137 CLASS="ERRORCODE"
 138 >EAI_FAIL</SPAN
 139 ></DT
 140 ><DD
 141 ><P
 142 >non-recoverable failure in name resolution</P
 143 ></DD
 144 ><DT
 145 ><SPAN
 146 CLASS="ERRORCODE"
 147 >EAI_FAMILY</SPAN
 148 ></DT
 149 ><DD
 150 ><P
 151 ><CODE
 152 CLASS="CONSTANT"
 153 >ai_family</CODE
 154 > not supported</P
 155 ></DD
 156 ><DT
 157 ><SPAN
 158 CLASS="ERRORCODE"
 159 >EAI_MEMORY</SPAN
 160 ></DT
 161 ><DD
 162 ><P
 163 >memory allocation failure</P
 164 ></DD
 165 ><DT
 166 ><SPAN
 167 CLASS="ERRORCODE"
 168 >EAI_NODATA</SPAN
 169 ></DT
 170 ><DD
 171 ><P
 172 >no address associated with hostname</P
 173 ></DD
 174 ><DT
 175 ><SPAN
 176 CLASS="ERRORCODE"
 177 >EAI_NONAME</SPAN
 178 ></DT
 179 ><DD
 180 ><P
 181 >hostname or servname not provided, or not known</P
 182 ></DD
 183 ><DT
 184 ><SPAN
 185 CLASS="ERRORCODE"
 186 >EAI_SERVICE</SPAN
 187 ></DT
 188 ><DD
 189 ><P
 190 >servname not supported for <CODE
 191 CLASS="CONSTANT"
 192 >ai_socktype</CODE
 193 ></P
 194 ></DD
 195 ><DT
 196 ><SPAN
 197 CLASS="ERRORCODE"
 198 >EAI_SOCKTYPE</SPAN
 199 ></DT
 200 ><DD
 201 ><P
 202 ><CODE
 203 CLASS="CONSTANT"
 204 >ai_socktype</CODE
 205 > not supported</P
 206 ></DD
 207 ><DT
 208 ><SPAN
 209 CLASS="ERRORCODE"
 210 >EAI_SYSTEM</SPAN
 211 ></DT
 212 ><DD
 213 ><P
 214 >system error returned in errno</P
 215 ></DD
 216 ></DL
 217 ></DIV
 218 >
 219 The message <SPAN
 220 CLASS="ERRORNAME"
 221 >invalid error code</SPAN
 222 > is returned if
 223 <VAR
 224 CLASS="PARAMETER"
 225 >ecode</VAR
 226 >
 227 is out of range.</P
 228 ><P
 229 ><CODE
 230 CLASS="CONSTANT"
 231 >ai_flags</CODE
 232 >,
 233 <CODE
 234 CLASS="CONSTANT"
 235 >ai_family</CODE
 236 >
 237 and
 238 <CODE
 239 CLASS="CONSTANT"
 240 >ai_socktype</CODE
 241 >
 242 are elements of the
 243 <SPAN
 244 CLASS="TYPE"
 245 >struct  addrinfo</SPAN
 246 >
 247 used by
 248 <CODE
 249 CLASS="FUNCTION"
 250 >lwres_getaddrinfo()</CODE
 251 >.</P
 252 ></DIV
 253 ><DIV
 254 CLASS="REFSECT1"
 255 ><A
 256 NAME="AEN92"
 257 ></A
 258 ><H2
 259 >SEE ALSO</H2
 260 ><P
 261 ><SPAN
 262 CLASS="CITEREFENTRY"
 263 ><SPAN
 264 CLASS="REFENTRYTITLE"
 265 >strerror</SPAN
 266 >(3)</SPAN
 267 >,
 268
 269 <SPAN
 270 CLASS="CITEREFENTRY"
 271 ><SPAN
 272 CLASS="REFENTRYTITLE"
 273 >lwres_getaddrinfo</SPAN
 274 >(3)</SPAN
 275 >,
 276
 277 <SPAN
 278 CLASS="CITEREFENTRY"
 279 ><SPAN
 280 CLASS="REFENTRYTITLE"
 281 >getaddrinfo</SPAN
 282 >(3)</SPAN
 283 >,
 284
 285 <SPAN
 286 CLASS="CITEREFENTRY"
 287 ><SPAN
 288 CLASS="REFENTRYTITLE"
 289 >RFC2133</SPAN
 290 ></SPAN
 291 >.</P
 292 ></DIV
 293 ></BODY
 294 ></HTML
 295 >