1.\" @(#)getrpcent.3n 2.2 88/08/02 4.0 RPCSRC; from 1.11 88/03/14 SMI 2.\" $FreeBSD$ 3.\" 4.Dd December 14, 1987 5.Dt GETRPCENT 3 6.Os 7.Sh NAME 8.Nm getrpcent , 9.Nm getrpcbyname , 10.Nm getrpcbynumber , 11.Nm endrpcent , 12.Nm setrpcent 13.Nd get RPC entry 14.Sh SYNOPSIS 15.Fd #include <rpc/rpc.h> 16.Ft struct rpcent * 17.Fn getrpcent void 18.Ft struct rpcent * 19.Fn getrpcbyname "char *name" 20.Ft struct rpcent * 21.Fn getrpcbynumber "int number" 22.Ft void 23.Fn setrpcent "int stayopen" 24.Ft void 25.Fn endrpcent void 26.Sh DESCRIPTION 27The 28.Fn getrpcent , 29.Fn getrpcbyname , 30and 31.Fn getrpcbynumber 32functions each return a pointer to an object with the 33following structure 34containing the broken-out 35fields of a line in the rpc program number data base, 36.Pa /etc/rpc . 37.Bd -literal 38 39struct rpcent { 40 char *r_name; /* name of server for this rpc program */ 41 char **r_aliases; /* alias list */ 42 long r_number; /* rpc program number */ 43}; 44.Ed 45.Pp 46The members of this structure are: 47.Bl -tag -width r_aliasesxxx 48.It Fa r_name 49The name of the server for this rpc program. 50.It Fa r_aliases 51A zero terminated list of alternate names for the rpc program. 52.It Fa r_number 53The rpc program number for this service. 54.El 55.Pp 56The 57.Fn getrpcent 58function reads the next line of the file, opening the file if necessary. 59The 60.Nm getrpcent 61function opens and rewinds the file. If the 62.Fa stayopen 63flag is non-zero, 64the net data base will not be closed after each call to 65.Fn getrpcent 66(either directly, or indirectly through one of 67the other 68.Fn getrpcent 69function family. 70.Pp 71.Fn endrpcent 72closes the file. 73.Pp 74.Fn getrpcbyname 75and 76.Fn getrpcbynumber 77sequentially search from the beginning 78of the file until a matching rpc program name or 79program number is found, or until end-of-file is encountered. 80.Sh FILES 81.Bl -tag -width /etc/rpc -compact 82.It Pa /etc/rpc 83.El 84.Sh "SEE ALSO" 85.Xr rpc 5 , 86.Xr rpcinfo 8 , 87.Xr ypserv 8 88.Sh DIAGNOSTICS 89A 90.Dv NULL 91pointer is returned on 92.Dv EOF 93or error. 94.Sh BUGS 95All information 96is contained in a static area 97so it must be copied if it is 98to be saved. 99