lib/libc/net/gai_strerror.3

   1 .\"     $NetBSD: gai_strerror.3,v 1.3 2006/02/22 14:26:30 ginsbach Exp $
   2 .\"     $KAME: gai_strerror.3,v 1.1 2005/01/05 03:04:47 itojun Exp $
   3 .\"     $OpenBSD: gai_strerror.3,v 1.4 2004/12/20 23:04:53 millert Exp $
   4 .\"
   5 .\" Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   6 .\" Copyright (C) 2000, 2001  Internet Software Consortium.
   7 .\"
   8 .\" Permission to use, copy, modify, and distribute this software for any
   9 .\" purpose with or without fee is hereby granted, provided that the above
  10 .\" copyright notice and this permission notice appear in all copies.
  11 .\"
  12 .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  13 .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  14 .\" AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  15 .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  16 .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  17 .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  18 .\" PERFORMANCE OF THIS SOFTWARE.
  19 .\"
  20 .Dd February 22, 2006
  21 .Dt GAI_STRERROR 3
  22 .Os
  23 .Sh NAME
  24 .Nm gai_strerror
  25 .Nd get error message string from EAI_xxx error code
  26 .Sh SYNOPSIS
  27 .In sys/types.h
  28 .In sys/socket.h
  29 .In netdb.h
  30 .Ft const char *
  31 .Fn gai_strerror "int ecode"
  32 .Sh DESCRIPTION
  33 The
  34 .Fn gai_strerror
  35 function returns an error message string corresponding to the error code
  36 returned by
  37 .Xr getaddrinfo 3
  38 or
  39 .Xr getnameinfo 3 .
  40 .Pp
  41 The following error codes and their meaning are defined in
  42 .Aq Pa netdb.h :
  43 .Pp
  44 .Bl -tag -width "EAI_ADDRFAMILYXX" -offset indent -compact
  45 .It Dv EAI_ADDRFAMILY
  46 address family for
  47 .Fa hostname
  48 not supported
  49 .It Dv EAI_AGAIN
  50 temporary failure in name resolution
  51 .It Dv EAI_BADFLAGS
  52 invalid value for
  53 .Fa ai_flags
  54 .It Dv EAI_BADHINTS
  55 invalid value for
  56 .Fa hints
  57 .It Dv EAI_FAIL
  58 non-recoverable failure in name resolution
  59 .It Dv EAI_FAMILY
  60 .Fa ai_family
  61 not supported.
  62 .It Dv EAI_MEMORY
  63 memory allocation failure
  64 .It Dv EAI_NODATA
  65 no address associated with
  66 .Fa hostname
  67 .It Dv EAI_NONAME
  68 .Fa hostname
  69 or
  70 .Fa servname
  71 not provided, or not known
  72 .It Dv EAI_OVERFLOW
  73 argument buffer overflow
  74 .It Dv EAI_PROTOCOL
  75 resolved protocol is unknown
  76 .It Dv EAI_SERVICE
  77 .Fa servname
  78 not supported for
  79 .Fa ai_socktype
  80 .It Dv EAI_SOCKTYPE
  81 .Fa ai_socktype
  82 not supported
  83 .It Dv EAI_SYSTEM
  84 system error returned in
  85 .Va errno
  86 .El
  87 .Sh RETURN VALUES
  88 .Fn gai_strerror
  89 returns a pointer to the error message string corresponding to
  90 .Fa ecode .
  91 If
  92 .Fa ecode
  93 is out of range, an implementation-specific error message string is returned.
  94 .Sh SEE ALSO
  95 .Xr getaddrinfo 3 ,
  96 .Xr getnameinfo 3