\"      @(#)getrpcent.3n        2.2 88/08/02 4.0 RPCSRC; from 1.11 88/03/14 SMI
\"      $NetBSD: getrpcent.3,v 1.15 2022/12/04 01:29:32 uwe Exp $
\"
Dd August 16, 2004
Dt GETRPCENT 3
Os
Sh NAME
Nm getrpcent ,
Nm getrpcbyname ,
Nm getrpcbynumber ,
Nm endrpcent ,
Nm setrpcent
Nd get RPC entry
Sh LIBRARY
Lb libc
Sh SYNOPSIS
In rpc/rpc.h
Ft struct rpcent *
Fn getrpcent void
Ft struct rpcent *
Fn getrpcbyname "const char *name"
Ft struct rpcent *
Fn getrpcbynumber "int number"
Ft void
Fn setrpcent "int stayopen"
Ft void
Fn endrpcent void
Sh DESCRIPTION
Fn getrpcent ,
Fn getrpcbyname ,
and
Fn getrpcbynumber ,
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,
Pa /etc/rpc :
Bd -literal -offset indent
struct rpcent {
       char    *r_name;        /* name of server for this rpc program */
       char    **r_aliases;    /* alias list */
       long    r_number;       /* rpc program number */
};
Ed
Pp
The members of this structure are:
Bl -tag -width r_aliases -offset indent
It r_name
The name of the server for this rpc program.
It r_aliases
A zero terminated list of alternative names for the rpc program.
It r_number
The rpc program number for this service.
El
Pp
Fn getrpcent
reads the next line of the file, opening the file if necessary.
Pp
Fn setrpcent
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
Fn getrpcent
(either directly, or indirectly through one of
the other
Dq getrpc
calls).
Pp
Fn endrpcent
closes the file.
Pp
Fn getrpcbyname
and
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.
Sh FILES
Pa /etc/rpc
Sh RETURN VALUES
A
Dv NULL
pointer is returned on
Dv EOF
or error.
Sh SEE ALSO
Xr rpc 5 ,
Xr rpcinfo 8 ,
Xr ypserv 8
Sh BUGS
All information
is contained in a static area
so it must be copied if it is
to be saved.