diff options
Diffstat (limited to 'upstream/archlinux/man3p/endprotoent.3p')
| -rw-r--r-- | upstream/archlinux/man3p/endprotoent.3p | 141 |
1 files changed, 141 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/endprotoent.3p b/upstream/archlinux/man3p/endprotoent.3p new file mode 100644 index 00000000..f7c46d95 --- /dev/null +++ b/upstream/archlinux/man3p/endprotoent.3p @@ -0,0 +1,141 @@ +'\" et +.TH ENDPROTOENT "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual" +.\" +.SH PROLOG +This manual page is part of the POSIX Programmer's Manual. +The Linux implementation of this interface may differ (consult +the corresponding Linux manual page for details of Linux behavior), +or the interface may not be implemented on Linux. +.\" +.SH NAME +endprotoent, +getprotobyname, +getprotobynumber, +getprotoent, +setprotoent +\(em network protocol database functions +.SH SYNOPSIS +.LP +.nf +#include <netdb.h> +.P +void endprotoent(void); +struct protoent *getprotobyname(const char *\fIname\fP); +struct protoent *getprotobynumber(int \fIproto\fP); +struct protoent *getprotoent(void); +void setprotoent(int \fIstayopen\fP); +.fi +.SH DESCRIPTION +These functions shall retrieve information about protocols. This +information is considered to be stored in a database that can be +accessed sequentially or randomly. The implementation of this database +is unspecified. +.P +The +\fIsetprotoent\fR() +function shall open a connection to the database, and set the next +entry to the first entry. If the +.IR stayopen +argument is non-zero, the connection to the network protocol database +shall not be closed after each call to +\fIgetprotoent\fR() +(either directly, or indirectly through one of the other +.IR getproto* (\|) +functions), and the implementation may maintain an open file descriptor +for the database. +.P +The +\fIgetprotobyname\fR() +function shall search the database from the beginning and find the +first entry for which the protocol name specified by +.IR name +matches the +.IR p_name +member, opening and closing a connection to the database as necessary. +.P +The +\fIgetprotobynumber\fR() +function shall search the database from the beginning and find the +first entry for which the protocol number specified by +.IR proto +matches the +.IR p_proto +member, opening and closing a connection to the database as necessary. +.P +The +\fIgetprotoent\fR() +function shall read the next entry of the database, opening and closing +a connection to the database as necessary. +.P +The +\fIgetprotobyname\fR(), +\fIgetprotobynumber\fR(), +and +\fIgetprotoent\fR() +functions shall each return a pointer to a +.BR protoent +structure, the members of which shall contain the fields of an entry in +the network protocol database. +.P +The +\fIendprotoent\fR() +function shall close the connection to the database, releasing any +open file descriptor. +.P +These functions need not be thread-safe. +.SH "RETURN VALUE" +Upon successful completion, +\fIgetprotobyname\fR(), +\fIgetprotobynumber\fR(), +and +\fIgetprotoent\fR() +return a pointer to a +.BR protoent +structure if the requested entry was found, and a null pointer if the +end of the database was reached or the requested entry was not found. +Otherwise, a null pointer is returned. +.P +The application shall not modify the structure to which the return +value points, nor any storage areas pointed to by pointers within the +structure. The returned pointer, and pointers within the structure, +might be invalidated or the structure or the storage areas might be +overwritten by a subsequent call to +\fIgetprotobyname\fR(), +\fIgetprotobynumber\fR(), +or +\fIgetprotoent\fR(). +The returned pointer, and pointers within the structure, might also be +invalidated if the calling thread is terminated. +.SH ERRORS +No errors are defined. +.LP +.IR "The following sections are informative." +.SH "EXAMPLES" +None. +.SH "APPLICATION USAGE" +None. +.SH "RATIONALE" +None. +.SH "FUTURE DIRECTIONS" +None. +.SH "SEE ALSO" +The Base Definitions volume of POSIX.1\(hy2017, +.IR "\fB<netdb.h>\fP" +.\" +.SH COPYRIGHT +Portions of this text are reprinted and reproduced in electronic form +from IEEE Std 1003.1-2017, Standard for Information Technology +-- Portable Operating System Interface (POSIX), The Open Group Base +Specifications Issue 7, 2018 Edition, +Copyright (C) 2018 by the Institute of +Electrical and Electronics Engineers, Inc and The Open Group. +In the event of any discrepancy between this version and the original IEEE and +The Open Group Standard, the original IEEE and The Open Group Standard +is the referee document. The original Standard can be obtained online at +http://www.opengroup.org/unix/online.html . +.PP +Any typographical or formatting errors that appear +in this page are most likely +to have been introduced during the conversion of the source files to +man page format. To report such errors, see +https://www.kernel.org/doc/man-pages/reporting_bugs.html . |