share/man/man3xnet/endnetent.3xnet

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" 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.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH ENDNETENT 3XNET "Jun 10, 2002"
  11 .SH NAME
  12 endnetent, getnetbyaddr, getnetbyname, getnetent, setnetent \- network database
  13 functions
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... [ \fIlibrary\fR ... ]
  18 #include <netdb.h>
  19
  20 \fBvoid\fR \fBendnetent\fR(\fBvoid);struct netent *getnetbyaddr(in_addr_t\fR \fInet\fR, \fBint\fR \fItype\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBstruct netent *\fR\fBgetnetbyname\fR(\fBconst char *\fR\fIname\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBstruct netent *\fR\fBgetnetent\fR(void)
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBvoid\fR \fBsetnetent\fR(\fBint\fR \fIstayopen\fR);
  36 .fi
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBgetnetbyaddr()\fR, \fBgetnetbyname()\fR and \fBgetnetent()\fR, functions
  42 each return a pointer to a \fBnetent\fR structure, the members of which contain
  43 the fields of an entry in the network database.
  44 .sp
  45 .LP
  46 The \fBgetnetent()\fR function reads the next entry of the database, opening a
  47 connection to the database if necessary.
  48 .sp
  49 .LP
  50 The \fBgetnetbyaddr()\fR function searches the database from the beginning, and
  51 finds the first entry for which the address family specified by \fBtype\fR
  52 matches the \fBn_addrtype\fR member and the network number \fInet\fR matches
  53 the \fBn_net\fR member, opening a connection to the database if necessary. The
  54 \fInet\fR argument is the network number in host byte order.
  55 .sp
  56 .LP
  57 The \fBgetnetbyname()\fR function searches the database from the beginning and
  58 finds the first entry for which the network name specified by \fIname\fR
  59 matches the \fBn_name\fR member, opening a connection to the database if
  60 necessary.
  61 .sp
  62 .LP
  63 The \fBsetnetent()\fR function opens and rewinds the database.  If the
  64 \fIstayopen\fR argument is non-zero, the connection to the net database will
  65 not be closed after each call to \fBgetnetent()\fR (either directly, or
  66 indirectly through one of the other \fBgetnet*(\|)\fR functions).
  67 .sp
  68 .LP
  69 The \fBendnetent()\fR function closes the database.
  70 .SH USAGE
  71 .sp
  72 .LP
  73 The \fBgetnetbyaddr()\fR, \fBgetnetbyname()\fR and \fBgetnetent()\fR, functions
  74 may return pointers to static data, which may be overwritten by subsequent
  75 calls to any of these functions.
  76 .sp
  77 .LP
  78 These functions are generally used with the Internet address family.
  79 .SH RETURN VALUES
  80 .sp
  81 .LP
  82 On successful completion, \fBgetnetbyaddr()\fR, \fBgetnetbyname()\fR and
  83 \fBgetnetent()\fR, return a pointer to a \fBnetent\fR structure if the
  84 requested entry was found, and a null pointer if the end of the database was
  85 reached or the requested entry was not found.  Otherwise, a null pointer is
  86 returned.
  87 .SH ERRORS
  88 .sp
  89 .LP
  90 No errors are defined.
  91 .SH ATTRIBUTES
  92 .sp
  93 .LP
  94 See \fBattributes\fR(5) for descriptions of the following attributes:
  95 .sp
  96
  97 .sp
  98 .TS
  99 box;
 100 c | c
 101 l | l .
 102 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 103 _
 104 Interface Stability     Standard
 105 _
 106 MT-Level        MT-Safe
 107 .TE
 108
 109 .SH SEE ALSO
 110 .sp
 111 .LP
 112 \fBattributes\fR(5), \fBstandards\fR(5)