usr/src/man/man3xnet/gai_strerror.3xnet

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  10 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  11 .TH GAI_STRERROR 3XNET "Dec 1, 2003"
  12 .SH NAME
  13 gai_strerror \- address and name information error description
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  18 #include <netdb.h>
  19
  20 \fBconst char *\fR\fBgai_strerror\fR(\fBint\fR \fIecode\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBgai_strerror()\fR function returns a text string describing an error
  27 value for the \fBgetaddrinfo\fR(3XNET) and \fBgetnameinfo\fR(3XNET) functions
  28 listed in the <\fBnetdb.h\fR> header.
  29 .sp
  30 .LP
  31 When the \fIecode\fR argument is one of the following values listed in the
  32 <\fBnetdb.h\fR> header:
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBEAI_AGAIN\fR\fR
  37 .ad
  38 .RS 16n
  39
  40 .RE
  41
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBEAI_BADFLAGS\fR\fR
  46 .ad
  47 .RS 16n
  48
  49 .RE
  50
  51 .sp
  52 .ne 2
  53 .na
  54 \fB\fBEAI_FAIL\fR\fR
  55 .ad
  56 .RS 16n
  57
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBEAI_FAMILY\fR\fR
  64 .ad
  65 .RS 16n
  66
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBEAI_MEMORY\fR\fR
  73 .ad
  74 .RS 16n
  75
  76 .RE
  77
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBEAI_NONAME\fR\fR
  82 .ad
  83 .RS 16n
  84
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBEAI_SERVICE\fR\fR
  91 .ad
  92 .RS 16n
  93
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBEAI_SOCKTYPE\fR\fR
 100 .ad
 101 .RS 16n
 102
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBEAI_SYSTEM\fR\fR
 109 .ad
 110 .RS 16n
 111
 112 .RE
 113
 114 .sp
 115 .LP
 116 the function return value points to a string describing the error. If the
 117 argument is not one of those values, the function returns a pointer to a string
 118 whose contents indicate an unknown error.
 119 .SH RETURN VALUES
 120 .sp
 121 .LP
 122 Upon successful completion, \fBgai_strerror()\fR returns a pointer to a string
 123 describing the error value.
 124 .SH ERRORS
 125 .sp
 126 .LP
 127 No errors are defined.
 128 .SH ATTRIBUTES
 129 .sp
 130 .LP
 131 See \fBattributes\fR(5) for descriptions of the following attributes:
 132 .sp
 133
 134 .sp
 135 .TS
 136 box;
 137 c | c
 138 l | l .
 139 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 140 _
 141 Interface Stability     Standard
 142 _
 143 MT-Level        MT-Safe
 144 .TE
 145
 146 .SH SEE ALSO
 147 .sp
 148 .LP
 149 \fBgetaddrinfo\fR(3XNET), \fBgetnameinfo\fR(3XNET), \fBattributes\fR(5),
 150 \fBstandards\fR(5)