$NetBSD: getrpcent.3,v 1.3 1997/03/08 13:41:48 mouse Exp $
.Dd December 14, 1987 .Dt GETRPCENT 3 .Os .Sh NAME .Nm getpwent , .Nm getrpcbyname , .Nm getrpcbynumber , .Nm endrpcent , .Nm setrpcent .Nd get RPC entry .Sh SYNOPSIS .Fd #include <netdb.h> .Ft struct rpcent * .Fn getrpcent void .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 .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,
a /etc/rpc : d -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
p The members of this structure are: l -tag -width r_aliases -offset indent t r_name The name of the server for this rpc program. t r_aliases A zero terminated list of alternative names for the rpc program. t r_number The rpc program number for this service. .El
p .Fn getrpcent reads the next line of the file, opening the file if necessary.
p .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).
p .Fn endrpcent closes the file.
p .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
a /etc/rpc .Sh SEE ALSO .Xr rpc 5 , .Xr rpcinfo 8 , .Xr ypserv 8 .Sh DIAGNOSTICS A .Dv NULL pointer is returned on .Dv EOF or error. .Sh BUGS All information is contained in a static area so it must be copied if it is to be saved.