xref: /illumos-gate/usr/src/man/man3xnet/endservent.3xnet (revision 6e6545bfaed3bab9ce836ee82d1abd8f2edba89a)

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
http://www.opengroup.org/bookstore/.

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 SunOS 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.

This notice shall appear on any product containing this material.

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.

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.

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]


Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (C) 2002, Sun Microsystems, Inc. All Rights Reserved.

ENDSERVENT 3XNET "Jun 14, 2002"
NAME
endservent, getservbyport, getservbyname, getservent, setservent - network services database functions
SYNOPSIS

cc [ flag ... ] file ... -lxnet [ library ... ]
#include <netdb.h>

void endservent(void)

struct servent *getservbyname(const char *name, const char *proto);

struct servent *getservbyport(int port, const char *proto);

struct servent *getservent(void)

void setservent(int stayopen);
DESCRIPTION

The getservbyname(), getservbyport() and getservent() functions each return a pointer to a servent structure, the members of which contain the fields of an entry in the network services database.

The getservent() function reads the next entry of the database, opening a connection to the database if necessary.

The getservbyname() function searches the database from the beginning and finds the first entry for which the service name specified by name matches the s_name member and the protocol name specified by proto matches the s_proto member, opening a connection to the database if necessary. If proto is a null pointer, any value of the s_proto member will be matched.

The getservbyport() function searches the database from the beginning and finds the first entry for which the port specified by port matches the s_port member and the protocol name specified by proto matches the s_proto member, opening a connection to the database if necessary. If proto is a null pointer, any value of the s_proto member will be matched. The port argument must be in network byte order.

The setservent() function opens a connection to the database, and sets the next entry to the first entry. If the stayopen argument is non-zero, the net database will not be closed after each call to the getservent() function, either directly, or indirectly through one of the other getserv*() functions.

The endservent() function closes the database.

USAGE

The port argument of getservbyport() need not be compatible with the port values of all address families.

The getservent(), getservbyname() and getservbyport() functions may return pointers to static data, which may be overwritten by subsequent calls to any of these functions.

These functions are generally used with the Internet address family.

RETURN VALUES

On successful completion, getservbyname(), getservbyport() and getservent() return a pointer to a servent structure if the requested entry was found, and a null pointer if the end of the database was reached or the requested entry was not found. Otherwise, a null pointer is returned.

ERRORS

No errors are defined.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

endhostent(3XNET), endprotoent(3XNET), htonl(3XNET), inet_addr(3XNET), attributes(5), standards(5)