freebsd-skq/lib/libc/rpc/getrpcent.3

99 lines
2.0 KiB
Groff
Raw Normal View History

.\" @(#)getrpcent.3n 2.2 88/08/02 4.0 RPCSRC; from 1.11 88/03/14 SMI
1999-08-28 00:22:10 +00:00
.\" $FreeBSD$
.\"
.Dd December 14, 1987
1996-12-21 22:56:48 +00:00
.Dt GETRPCENT 3
.Os
.Sh NAME
1996-12-21 22:56:48 +00:00
.Nm getrpcent ,
.Nm getrpcbyname ,
.Nm getrpcbynumber ,
.Nm endrpcent ,
.Nm setrpcent
1996-12-21 22:56:48 +00:00
.Nd get RPC entry
.Sh SYNOPSIS
.Fd #include <rpc/rpc.h>
1996-12-21 22:56:48 +00:00
.Ft struct rpcent *
.Fn getrpcent void
1996-12-21 22:56:48 +00:00
.Ft struct rpcent *
.Fn getrpcbyname "char *name"
.Ft struct rpcent *
.Fn getrpcbynumber "int number"
.Ft void
.Fn setrpcent "int stayopen"
.Ft void
.Fn endrpcent void
1996-12-21 22:56:48 +00:00
.Sh DESCRIPTION
The
.Fn getrpcent ,
.Fn getrpcbyname ,
and
1996-12-21 22:56:48 +00:00
.Fn getrpcbynumber
functions each return a pointer to an object with the
following structure
containing the broken-out
fields of a line in the rpc program number data base,
1996-12-21 22:56:48 +00:00
.Pa /etc/rpc .
.Bd -literal
struct rpcent {
char *r_name; /* name of server for this rpc program */
char **r_aliases; /* alias list */
long r_number; /* rpc program number */
};
1996-12-21 22:56:48 +00:00
.Ed
.Pp
The members of this structure are:
1996-12-21 22:56:48 +00:00
.Bl -tag -width r_aliasesxxx
.It Fa r_name
The name of the server for this rpc program.
1996-12-21 22:56:48 +00:00
.It Fa r_aliases
A zero terminated list of alternate names for the rpc program.
1996-12-21 22:56:48 +00:00
.It Fa r_number
The rpc program number for this service.
1996-12-21 22:56:48 +00:00
.El
.Pp
The
.Fn getrpcent
function reads the next line of the file, opening the file if necessary.
The
.Fn setrpcent
1996-12-21 22:56:48 +00:00
function opens and rewinds the file. If the
.Fa stayopen
flag is non-zero,
the net data base will not be closed after each call to
1996-12-21 22:56:48 +00:00
.Fn getrpcent
(either directly, or indirectly through one of
1996-12-21 22:56:48 +00:00
the other
.Fn getrpcent
function family.
.Pp
.Fn endrpcent
closes the file.
1996-12-21 22:56:48 +00:00
.Pp
.Fn getrpcbyname
and
1996-12-21 22:56:48 +00:00
.Fn getrpcbynumber
sequentially search from the beginning
of the file until a matching rpc program name or
program number is found, or until end-of-file is encountered.
1996-12-21 22:56:48 +00:00
.Sh FILES
.Bl -tag -width /etc/rpc -compact
.It Pa /etc/rpc
.El
.Sh "SEE ALSO"
.Xr rpc 5 ,
.Xr rpcinfo 8 ,
.Xr ypserv 8
.Sh DIAGNOSTICS
A
1996-12-21 22:56:48 +00:00
.Dv NULL
pointer is returned on
1996-12-21 22:56:48 +00:00
.Dv EOF
or error.
1996-12-21 22:56:48 +00:00
.Sh BUGS
All information
is contained in a static area
so it must be copied if it is
to be saved.