2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" References consulted:
|
|
|
|
.\" Linux libc source code
|
|
|
|
.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
|
|
|
|
.\" 386BSD man pages
|
|
|
|
.\" Modified Sat Jul 24 19:26:03 1993 by Rik Faith (faith@cs.unc.edu)
|
2008-08-18 13:40:35 +00:00
|
|
|
.TH GETPROTOENT 3 2008-08-19 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
getprotoent, getprotobyname, getprotobynumber, setprotoent,
|
|
|
|
endprotoent \- get protocol entry
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <netdb.h>
|
|
|
|
.sp
|
|
|
|
.B struct protoent *getprotoent(void);
|
|
|
|
.sp
|
|
|
|
.BI "struct protoent *getprotobyname(const char *" name );
|
|
|
|
.sp
|
|
|
|
.BI "struct protoent *getprotobynumber(int " proto );
|
|
|
|
.sp
|
|
|
|
.BI "void setprotoent(int " stayopen );
|
|
|
|
.sp
|
|
|
|
.B void endprotoent(void);
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR getprotoent ()
|
2008-08-13 05:17:08 +00:00
|
|
|
function reads the next entry from the protocols database (see
|
|
|
|
.BR protocols (5))
|
|
|
|
and returns a \fIprotoent\fP structure
|
|
|
|
containing the broken-out fields from the entry.
|
|
|
|
A connection is opened to the database if necessary.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR getprotobyname ()
|
2008-08-13 05:17:08 +00:00
|
|
|
function returns a \fIprotoent\fP structure
|
|
|
|
for the entry from the database
|
|
|
|
that matches the protocol name \fIname\fP.
|
|
|
|
A connection is opened to the database if necessary.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR getprotobynumber ()
|
2008-08-13 05:17:08 +00:00
|
|
|
function returns a \fIprotoent\fP structure
|
|
|
|
for the entry from the database
|
|
|
|
that matches the protocol number \fInumber\fP.
|
|
|
|
A connection is opened to the database if necessary.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR setprotoent ()
|
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 getproto* ()
|
|
|
|
functions.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR endprotoent ()
|
2008-08-13 05:17:08 +00:00
|
|
|
function closes the connection to the database.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
The \fIprotoent\fP structure is defined in \fI<netdb.h>\fP as follows:
|
|
|
|
.sp
|
2007-12-19 05:53:30 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
|
|
|
struct protoent {
|
2007-04-05 13:29:41 +00:00
|
|
|
char *p_name; /* official protocol name */
|
|
|
|
char **p_aliases; /* alias list */
|
|
|
|
int p_proto; /* protocol number */
|
2004-11-03 13:51:07 +00:00
|
|
|
}
|
|
|
|
.fi
|
2007-12-19 05:53:30 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
The members of the \fIprotoent\fP structure are:
|
|
|
|
.TP
|
|
|
|
.I p_name
|
|
|
|
The official name of the protocol.
|
|
|
|
.TP
|
|
|
|
.I p_aliases
|
2008-08-13 05:17:08 +00:00
|
|
|
A NULL-terminated list of alternative names for the protocol.
|
2004-11-03 13:51:07 +00:00
|
|
|
.TP
|
|
|
|
.I p_proto
|
|
|
|
The protocol number.
|
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR getprotoent (),
|
|
|
|
.BR getprotobyname ()
|
|
|
|
and
|
|
|
|
.BR getprotobynumber ()
|
2008-08-18 13:37:40 +00:00
|
|
|
functions return a pointer to a
|
|
|
|
statically allocated \fIprotoent\fP structure, or a NULL pointer if an
|
2004-11-03 13:51:07 +00:00
|
|
|
error occurs or the end of the file is reached.
|
|
|
|
.SH FILES
|
|
|
|
.PD 0
|
|
|
|
.TP
|
|
|
|
.I /etc/protocols
|
|
|
|
protocol database file
|
|
|
|
.PD
|
|
|
|
.SH "CONFORMING TO"
|
2006-08-03 13:57:30 +00:00
|
|
|
4.3BSD, POSIX.1-2001.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR getnetent (3),
|
2008-08-18 13:37:40 +00:00
|
|
|
.BR getprotent_r (3),
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR getservent (3),
|
|
|
|
.BR protocols (5)
|