man-pages/man3/getrpcent.3

109 lines
2.4 KiB
Groff
Raw Normal View History

2008-01-01 07:47:27 +00:00
.\" This page was taken from the 4.4BSD-Lite CDROM (BSD license)
.\"
2004-11-03 13:51:07 +00:00
.\" @(#)getrpcent.3n 2.2 88/08/02 4.0 RPCSRC; from 1.11 88/03/14 SMI
2008-08-18 13:40:35 +00:00
.TH GETRPCENT 3 2008-08-19 "" "Linux Programmer's Manual"
2004-11-03 13:51:07 +00:00
.SH NAME
getrpcent, getrpcbyname, getrpcbynumber, setrpcent, endrpcent \- get
RPC entry
2004-11-03 13:51:07 +00:00
.SH SYNOPSIS
.nf
2007-12-23 07:50:04 +00:00
.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);"
2004-11-03 13:51:07 +00:00
.fi
.SH DESCRIPTION
.LP
The
.BR getrpcent (),
.BR getrpcbyname (),
2004-11-03 13:51:07 +00:00
and
.BR getrpcbynumber ()
functions each return a pointer to an object with the
2007-12-30 06:09:59 +00:00
following structure containing the broken-out
fields of an entry in the RPC program number data base.
.in +4n
2004-11-03 13:51:07 +00:00
.nf
2007-12-23 08:20:39 +00:00
struct rpcent {
char *r_name; /* name of server for this RPC program */
char **r_aliases; /* alias list */
long r_number; /* RPC program number */
2004-11-03 13:51:07 +00:00
};
.fi
.in
2004-11-03 13:51:07 +00:00
.LP
The members of this structure are:
2007-12-30 06:09:59 +00:00
.RS 4
.TP 12
2007-06-23 07:56:56 +00:00
.I r_name
The name of the server for this RPC program.
.TP
2007-06-23 07:56:56 +00:00
.I r_aliases
A NULL-terminated list of alternate names for the RPC program.
.TP
2007-06-23 07:56:56 +00:00
.I r_number
The RPC program number for this service.
2007-12-30 06:09:59 +00:00
.RE
2004-11-03 13:51:07 +00:00
.LP
The
.BR getrpcent ()
function reads the next entry from the database.
A connection is opened to the database if necessary.
2004-11-03 13:51:07 +00:00
.LP
The
.BR setrpcent ()
function opens a connection to the database,
and sets the next entry to the first entry.
intro.1, time.1, adjtimex.2, capget.2, eventfd.2, fcntl.2, getrlimit.2, getsockopt.2, gettimeofday.2, intro.2, ioctl_list.2, ioperm.2, mlock.2, pivot_root.2, poll.2, prctl.2, ptrace.2, sched_setscheduler.2, select_tut.2, semget.2, sigaltstack.2, signalfd.2, sysctl.2, timer_settime.2, timerfd_create.2, wait.2, CPU_SET.3, argz_add.3, assert_perror.3, atexit.3, backtrace.3, bcmp.3, clearenv.3, ctime.3, dl_iterate_phdr.3, dlopen.3, ecvt.3, errno.3, error.3, ether_aton.3, exit.3, fenv.3, ferror.3, finite.3, flockfile.3, fnmatch.3, fpathconf.3, fpclassify.3, ftime.3, ftok.3, ftw.3, fwide.3, getaddrinfo.3, gethostbyname.3, getlogin.3, getnameinfo.3, getnetent.3, getopt.3, getprotoent.3, getrpcent.3, getservent.3, glob.3, hsearch.3, inet.3, isalpha.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, longjmp.3, lsearch.3, malloc.3, matherr.3, mblen.3, mbsinit.3, mbtowc.3, on_exit.3, printf.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_attr_setdetachstate.3, pthread_attr_setguardsize.3, pthread_attr_setinheritsched.3, pthread_attr_setschedparam.3, pthread_attr_setschedpolicy.3, pthread_attr_setscope.3, pthread_attr_setstack.3, pthread_attr_setstackaddr.3, pthread_attr_setstacksize.3, pthread_cancel.3, pthread_cleanup_push.3, pthread_equal.3, pthread_getattr_np.3, pthread_getcpuclockid.3, pthread_setaffinity_np.3, pthread_setcancelstate.3, pthread_setconcurrency.3, pthread_setschedparam.3, pthread_setschedprio.3, ptsname.3, putenv.3, putgrent.3, raise.3, rcmd.3, regex.3, rexec.3, rpc.3, rpmatch.3, rtnetlink.3, scandir.3, sem_init.3, setaliasent.3, setbuf.3, setenv.3, setjmp.3, signbit.3, stdio_ext.3, strtod.3, strtol.3, strtoul.3, system.3, termios.3, timeradd.3, tzset.3, ualarm.3, wctomb.3, xdr.3, st.4, tty_ioctl.4, core.5, elf.5, proc.5, bootparam.7, capabilities.7, icmp.7, ip.7, ipv6.7, math_error.7, mdoc.samples.7, mq_overview.7, pthreads.7, raw.7, regex.7, socket.7, tcp.7, tzselect.8: Global fix: s/non-zero/nonzero/ The tendency in English, as prescribed in style guides like Chicago MoS, is towards removing hyphens after prefixes like "non-" etc. Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:40:55 +00:00
If \fIstayopen\fP is nonzero,
then the connection to the database
will not be closed between calls to one of the
.BR getrpc* ()
functions.
2004-11-03 13:51:07 +00:00
.LP
The
.BR endrpcent ()
function closes the connection to the database.
2004-11-03 13:51:07 +00:00
.LP
The
.BR getrpcbyname ()
2004-11-03 13:51:07 +00:00
and
.BR getrpcbynumber ()
functions sequentially search from the beginning
of the file until a matching RPC program name or
2004-11-03 13:51:07 +00:00
program number is found, or until end-of-file is encountered.
.SH RETURN VALUE
On success,
.BR getrpcent (),
.BR getrpcbyname (),
and
.BR getrpcbynumber ()
return a pointer to a statically allocated
.I rpcent
structure.
2007-12-30 06:09:59 +00:00
A NULL pointer is returned on EOF or error.
.SH FILES
.TP
.I /etc/rpc
RPC program number database.
.SH "CONFORMING TO"
Not in POSIX.1-2001.
Present on the BSDs, Solaris, and many other systems.
2004-11-03 13:51:07 +00:00
.SH BUGS
All information
is contained in a static area
so it must be copied if it is
to be saved.
2007-05-16 18:25:50 +00:00
.SH "SEE ALSO"
.BR getrpcent_r (3),
2007-05-16 18:25:50 +00:00
.BR rpc (5),
.BR rpcinfo (8),
.BR ypserv (8)