man-pages/man3/getrpcent.3

.\" This page was taken from the 4.4BSD-Lite CDROM (BSD license)
.\"
.\" @(#)getrpcent.3n	2.2 88/08/02 4.0 RPCSRC; from 1.11 88/03/14 SMI
.TH GETRPCENT 3 2007-12-23 "" "Linux Programmer's Manual"
.SH NAME
getrpcent, getrpcbyname, getrpcbynumber, setrpcent, endrpcent \- get
RPC entry
.SH SYNOPSIS
.nf
.B #include <netdb.h>

.BI "struct rpcent *getrpcent(void);"

.BI "struct rpcent *getrpcbyname(char *" name );

.BI "struct rpcent *getrpcbynumber(int " number );

.BI "void setrpcent(int " stayopen );

.BI "void endrpcent(void);"
.fi
.SH DESCRIPTION
.LP
.BR getrpcent (),
.BR getrpcbyname (),
and
.BR 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,
.IR /etc/rpc .
.in +4n
.nf

struct rpcent {
    char  *r_name;     /* name of server for this rpc program */
    char **r_aliases;  /* alias list */
    long   r_number;   /* rpc program number */
};
.fi
.in
.LP
The members of this structure are:
.RS 4
.TP 12
.I r_name
The name of the server for this rpc program.
.TP
.I r_aliases
A zero terminated list of alternate names for the rpc program.
.TP
.I r_number
The rpc program number for this service.
.RE
.LP
.BR getrpcent ()
reads the next line of the file, opening the file if necessary.
.LP
.BR setrpcent ()
opens and rewinds the file.
If the
.I stayopen
flag is non-zero,
the net data base will not be closed after each call to
.BR getrpcent ()
(either directly, or indirectly through one of
the other \*(lqgetrpc\*(rq calls).
.LP
.BR endrpcent ()
closes the file.
.LP
.BR getrpcbyname ()
and
.BR 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 RETURN VALUE
.LP
A NULL pointer is returned on EOF or error.
.SH FILES
.I /etc/rpc
.SH "CONFORMING TO"
Not in POSIX.1-2001.
Present on the BSDs, Solaris, and many other systems.
.SH BUGS
All information
is contained in a static area
so it must be copied if it is
to be saved.
.SH "SEE ALSO"
.BR rpc (5),
.BR rpcinfo (8),
.BR ypserv (8)