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

   1 '\" te
   2 .\" Copyright (c) 1997, 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 ENDHOSTENT 3XNET "Nov 1, 2003"
  12 .SH NAME
  13 endhostent, gethostbyaddr, gethostbyname, gethostent, sethostent \- network
  14 host database functions
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  19 #include <netdb.h>
  20 extern int h_errno;
  21
  22 \fBvoid\fR \fBendhostent\fR(void)
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBstruct hostent *\fR\fBgethostbyaddr\fR(\fBconst void *\fR\fIaddr\fR, \fBsocklen_t\fR \fIlen\fR, \fBint\fR \fItype\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBstruct hostent *\fR\fBgethostbyname\fR(\fBconst char *\fR\fIname\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBstruct hostent *\fR\fBgethostent\fR(void)
  38 .fi
  39
  40 .LP
  41 .nf
  42 \fBvoid\fR \fBsethostent\fR(\fBint\fR \fIstayopen\fR);
  43 .fi
  44
  45 .SH DESCRIPTION
  46 .sp
  47 .LP
  48 The \fBgethostent()\fR, \fBgethostbyaddr()\fR, and \fBgethostbyname()\fR
  49 functions each return a pointer to a \fBhostent\fR structure, the members of
  50 which contain the fields of an entry in the network host database.
  51 .sp
  52 .LP
  53 The \fBgethostent()\fR function reads the next entry of the database, opening a
  54 connection to the database if necessary.
  55 .sp
  56 .LP
  57 The \fBgethostbyaddr()\fR function searches the database and finds an entry
  58 which matches the address family specified by the \fBtype\fR argument and which
  59 matches the address pointed to by the \fIaddr\fR argument,  opening a
  60 connection to the database if necessary.  The \fIaddr\fR argument is a pointer
  61 to the binary-format (that is, not null-terminated) address in network byte
  62 order, whose length is specified by the \fIlen\fR argument.  The datatype of
  63 the address depends on the address family.  For an address of type
  64 \fBAF_INET\fR, this is an \fBin_addr\fR structure, defined in
  65 <\fBnetinet/in.h\fR>. For an address of type \fBAF_INET6\fR, there is an
  66 \fBin6_addr\fR structure defined in <\fBnetinet/in.h\fR>.
  67 .sp
  68 .LP
  69 The \fBgethostbyname()\fR function searches the database and finds an entry
  70 which matches the host name specified by the \fIname\fR argument, opening a
  71 connection to the database if necessary. If  \fIname\fR is an alias for a valid
  72 host name, the function returns information about the host name  to which the
  73 alias refers, and  \fIname\fR is included in the list of aliases returned.
  74 .sp
  75 .LP
  76 The \fBsethostent()\fR function opens a connection to the network host
  77 database, and sets the position of the next entry to the first entry.  If the
  78 \fIstayopen\fR argument is non-zero, the connection to the host database will
  79 not be closed after each call to \fBgethostent()\fR (either directly, or
  80 indirectly through one of the other \fBgethost*(\|)\fR functions).
  81 .sp
  82 .LP
  83 The \fBendhostent()\fR function closes the connection to the database.
  84 .SH USAGE
  85 .sp
  86 .LP
  87 The \fBgethostent()\fR, \fBgethostbyaddr()\fR, and \fBgethostbyname()\fR
  88 functions may return pointers to static data, which may be overwritten by
  89 subsequent calls to any of these functions.
  90 .sp
  91 .LP
  92 These functions are generally used with the Internet address family.
  93 .SH RETURN VALUES
  94 .sp
  95 .LP
  96 On successful completion, \fBgethostbyaddr()\fR, \fBgethostbyname()\fR and
  97 \fBgethostent()\fR return a pointer to a \fBhostent\fR structure if the
  98 requested entry was found, and a null pointer if the end of the database was
  99 reached or the requested entry was not found.  Otherwise, a null pointer is
 100 returned.
 101 .sp
 102 .LP
 103 On unsuccessful completion, \fBgethostbyaddr()\fR and \fBgethostbyname()\fR
 104 functions set \fIh_errno\fR to indicate the error.
 105 .SH ERRORS
 106 .sp
 107 .LP
 108 No errors are defined for \fBendhostent()\fR, \fBgethostent()\fR and
 109 \fBsethostent()\fR.
 110 .sp
 111 .LP
 112 The \fBgethostbyaddr()\fR and \fBgethostbyname()\fR functions will fail in the
 113 following cases, setting \fIh_errno\fR to the value shown in the list below.
 114 Any changes to \fBerrno\fR are unspecified.
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBHOST_NOT_FOUND\fR\fR
 119 .ad
 120 .RS 18n
 121 No such host is known.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBNO_DATA\fR\fR
 128 .ad
 129 .RS 18n
 130 The server recognised the request and the name but no address is available.
 131 Another type of request to the name server for the domain might return an
 132 answer.
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBNO_RECOVERY\fR\fR
 139 .ad
 140 .RS 18n
 141 An unexpected server failure occurred which can not be recovered.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBTRY_AGAIN\fR\fR
 148 .ad
 149 .RS 18n
 150 A temporary and possibly transient error occurred, such as a failure of a
 151 server to respond.
 152 .RE
 153
 154 .SH ATTRIBUTES
 155 .sp
 156 .LP
 157 See \fBattributes\fR(5) for descriptions of the following attributes:
 158 .sp
 159
 160 .sp
 161 .TS
 162 box;
 163 c | c
 164 l | l .
 165 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 166 _
 167 Interface Stability     Standard
 168 _
 169 MT-Level        MT-Safe
 170 .TE
 171
 172 .SH SEE ALSO
 173 .sp
 174 .LP
 175 \fBendservent\fR(3XNET), \fBhtonl\fR(3XNET), \fBinet_addr\fR(3XNET),
 176 \fBattributes\fR(5), \fBstandards\fR(5)