2008-01-01 07:47:27 +00:00
|
|
|
.\" This page was taken from the 4.4BSD-Lite CDROM (BSD license)
|
2006-05-31 22:43:24 +00:00
|
|
|
.\"
|
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
|
2007-07-08 14:47:01 +00:00
|
|
|
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
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getrpcent (),
|
|
|
|
.BR getrpcbyname (),
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getrpcbynumber ()
|
2004-11-03 13:51:07 +00:00
|
|
|
each return a pointer to an object with the
|
2007-12-30 06:09:59 +00:00
|
|
|
following structure containing the broken-out
|
2008-08-13 05:17:08 +00:00
|
|
|
fields of an entry in the RPC program number data base.
|
2007-12-19 06:16:04 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
2007-12-23 08:20:39 +00:00
|
|
|
|
2007-12-19 05:53:30 +00:00
|
|
|
struct rpcent {
|
2008-08-13 05:17:08 +00:00
|
|
|
char *r_name; /* name of server for this RPC program */
|
2007-12-19 05:53:30 +00:00
|
|
|
char **r_aliases; /* alias list */
|
2008-08-13 05:17:08 +00:00
|
|
|
long r_number; /* RPC program number */
|
2004-11-03 13:51:07 +00:00
|
|
|
};
|
|
|
|
.fi
|
2007-12-19 06:16:04 +00:00
|
|
|
.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
|
2008-08-13 05:17:08 +00:00
|
|
|
The name of the server for this RPC program.
|
2007-12-19 05:53:30 +00:00
|
|
|
.TP
|
2007-06-23 07:56:56 +00:00
|
|
|
.I r_aliases
|
2008-08-13 05:17:08 +00:00
|
|
|
A NULL-terminated list of alternate names for the RPC program.
|
2007-12-19 05:53:30 +00:00
|
|
|
.TP
|
2007-06-23 07:56:56 +00:00
|
|
|
.I r_number
|
2008-08-13 05:17:08 +00:00
|
|
|
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
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getrpcent ()
|
2008-08-13 05:17:08 +00:00
|
|
|
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
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR setrpcent ()
|
2008-08-13 05:17:08 +00:00
|
|
|
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,
|
2008-08-13 05:17:08 +00:00
|
|
|
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
|
2008-08-13 05:17:08 +00:00
|
|
|
The
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR endrpcent ()
|
2008-08-13 05:17:08 +00:00
|
|
|
function closes the connection to the database.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getrpcbyname ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getrpcbynumber ()
|
2004-11-03 13:51:07 +00:00
|
|
|
sequentially search from the beginning
|
2008-08-13 05:17:08 +00:00
|
|
|
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.
|
2007-05-16 17:35:34 +00:00
|
|
|
.SH RETURN VALUE
|
2008-08-18 13:39:50 +00:00
|
|
|
On success,
|
|
|
|
.BR getrpcent (),
|
|
|
|
.BR getrpcbyname (),
|
|
|
|
and
|
|
|
|
.BR getrpcbynumber ()
|
2009-01-22 19:53:07 +00:00
|
|
|
return a pointer to a statically allocated
|
2008-08-18 13:39:50 +00:00
|
|
|
.I rpcent
|
|
|
|
structure.
|
2007-12-30 06:09:59 +00:00
|
|
|
A NULL pointer is returned on EOF or error.
|
2007-05-19 04:30:20 +00:00
|
|
|
.SH FILES
|
2008-08-13 05:17:08 +00:00
|
|
|
.TP
|
2007-05-19 04:30:20 +00:00
|
|
|
.I /etc/rpc
|
2008-08-13 05:17:08 +00:00
|
|
|
RPC program number database.
|
2007-05-19 04:30:20 +00:00
|
|
|
.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"
|
2008-08-18 13:39:50 +00:00
|
|
|
.BR getrpcent_r (3),
|
2007-05-16 18:25:50 +00:00
|
|
|
.BR rpc (5),
|
|
|
|
.BR rpcinfo (8),
|
|
|
|
.BR ypserv (8)
|