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