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 2008-08-13 "" "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 an entry in the RPC program number data base.
.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 NULL-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 entry from the database.
A connection is opened to the database if necessary.
.LP
.BR setrpcent ()
function opens a connection to the database,
and sets the next entry to the first entry.
If \fIstayopen\fP is non-zero,
then the connection to the database
will not be closed between calls to one of the
.BR getrpc* ()
functions.
.LP
The
.BR endrpcent ()
function closes the connection to the database.
.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
.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.
.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)
tfix 2008-01-01 07:47:27 +00:00			`.\" This page was taken from the 4.4BSD-Lite CDROM (BSD license)`
Added following to top of these pages to clarify origin and license: .\" This page was taken from the 4.4BSD-Lite CDROM (BSD license) 2006-05-31 22:43:24 +00:00			`.\"`
Import of man-pages 1.70 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`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`.TH GETRPCENT 3 2008-08-13 "" "Linux Programmer's Manual"`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.SH NAME`
Add setrpcent and endrpcent to NAME line. 2007-07-08 14:47:01 +00:00			`getrpcent, getrpcbyname, getrpcbynumber, setrpcent, endrpcent \- get`
			`RPC entry`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.SH SYNOPSIS`
			`.nf`
Use modern C prototypes in SYNOPSIS. 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);"`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.fi`
			`.SH DESCRIPTION`
			`.LP`
Automated unformatting of parentheses using unformat_parens.sh 2005-10-19 07:07:02 +00:00			`.BR getrpcent (),`
			`.BR getrpcbyname (),`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`and`
Automated unformatting of parentheses using unformat_parens.sh 2005-10-19 07:07:02 +00:00			`.BR getrpcbynumber ()`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`each return a pointer to an object with the`
ffixes 2007-12-30 06:09:59 +00:00			`following structure containing the broken-out`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`fields of an entry in the RPC program number data base.`
enclose code smaples/structure defns/etc in ".in +4n / .in" 2007-12-19 06:16:04 +00:00			`.in +4n`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.nf`
Format SYNOPSIS consistently. 2007-12-23 08:20:39 +00:00
Make the standard indent for code samples, shell session logs, etc. to be ".in +4n". 2007-12-19 05:53:30 +00:00			`struct rpcent {`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`char r_name; / name of server for this RPC program */`
Make the standard indent for code samples, shell session logs, etc. to be ".in +4n". 2007-12-19 05:53:30 +00:00			`char *r_aliases; / alias list */`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`long r_number; /* RPC program number */`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`};`
			`.fi`
enclose code smaples/structure defns/etc in ".in +4n / .in" 2007-12-19 06:16:04 +00:00			`.in`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.LP`
			`The members of this structure are:`
ffixes 2007-12-30 06:09:59 +00:00			`.RS 4`
			`.TP 12`
ffix 2007-06-23 07:56:56 +00:00			`.I r_name`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`The name of the server for this RPC program.`
Make the standard indent for code samples, shell session logs, etc. to be ".in +4n". 2007-12-19 05:53:30 +00:00			`.TP`
ffix 2007-06-23 07:56:56 +00:00			`.I r_aliases`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`A NULL-terminated list of alternate names for the RPC program.`
Make the standard indent for code samples, shell session logs, etc. to be ".in +4n". 2007-12-19 05:53:30 +00:00			`.TP`
ffix 2007-06-23 07:56:56 +00:00			`.I r_number`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`The RPC program number for this service.`
ffixes 2007-12-30 06:09:59 +00:00			`.RE`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.LP`
Automated unformatting of parentheses using unformat_parens.sh 2005-10-19 07:07:02 +00:00			`.BR getrpcent ()`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`reads the next entry from the database.`
			`A connection is opened to the database if necessary.`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.LP`
Automated unformatting of parentheses using unformat_parens.sh 2005-10-19 07:07:02 +00:00			`.BR setrpcent ()`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`function opens a connection to the database,`
			`and sets the next entry to the first entry.`
			`If \fIstayopen\fP is non-zero,`
			`then the connection to the database`
			`will not be closed between calls to one of the`
			`.BR getrpc* ()`
			`functions.`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.LP`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`The`
Automated addition of parentheses by add_parens_for_own_funcs.sh 2005-10-19 06:54:38 +00:00			`.BR endrpcent ()`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`function closes the connection to the database.`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.LP`
Automated unformatting of parentheses using unformat_parens.sh 2005-10-19 07:07:02 +00:00			`.BR getrpcbyname ()`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`and`
Automated unformatting of parentheses using unformat_parens.sh 2005-10-19 07:07:02 +00:00			`.BR getrpcbynumber ()`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`sequentially search from the beginning`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`of the file until a matching RPC program name or`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`program number is found, or until end-of-file is encountered.`
Convert SH to SS and other section-related fixes. 2007-05-16 17:35:34 +00:00			`.SH RETURN VALUE`
Import of man-pages 1.70 2004-11-03 13:51:07 +00:00			`.LP`
ffixes 2007-12-30 06:09:59 +00:00			`A NULL pointer is returned on EOF or error.`
Fix inconsistencies in order of .SH sections 2007-05-19 04:30:20 +00:00			`.SH FILES`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`.TP`
Fix inconsistencies in order of .SH sections 2007-05-19 04:30:20 +00:00			`.I /etc/rpc`
Rephrase description in terms of a database, rather than a file. Note that each of the get() functions opens a connection to the database if necessary. The database connection is held opend between get() calls if 'stayopen' is non-zero (not necessarily 1). s/zero terminated list/NULL-terminated list/ 2008-08-13 05:17:08 +00:00			`RPC program number database.`
Fix inconsistencies in order of .SH sections 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.`
Import of man-pages 1.70 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.`
Move SEE ALSO section to end of page 2007-05-16 18:25:50 +00:00			`.SH "SEE ALSO"`
			`.BR rpc (5),`
			`.BR rpcinfo (8),`
			`.BR ypserv (8)`