1.\" $NetBSD: getprotoent.3,v 1.11 2003/08/07 16:43:09 agc Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.\" @(#)getprotoent.3 8.1 (Berkeley) 6/4/93 31.\" 32.Dd June 4, 1993 33.Dt GETPROTOENT 3 34.Os 35.Sh NAME 36.Nm getprotoent , 37.Nm getprotobynumber , 38.Nm getprotobyname , 39.Nm setprotoent , 40.Nm endprotoent 41.Nd get protocol entry 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.In netdb.h 46.Ft struct protoent * 47.Fn getprotoent 48.Ft struct protoent * 49.Fn getprotobyname "const char *name" 50.Ft struct protoent * 51.Fn getprotobynumber "int proto" 52.Fn setprotoent "int stayopen" 53.Fn endprotoent 54.Sh DESCRIPTION 55The 56.Fn getprotoent , 57.Fn getprotobyname , 58and 59.Fn getprotobynumber 60functions 61each return a pointer to an object with the 62following structure 63containing the broken-out 64fields of a line in the network protocol data base, 65.Pa /etc/protocols . 66.Bd -literal -offset indent 67.Pp 68struct protoent { 69 char *p_name; /* official name of protocol */ 70 char **p_aliases; /* alias list */ 71 int p_proto; /* protocol number */ 72}; 73.Ed 74.Pp 75The members of this structure are: 76.Bl -tag -width p_aliases 77.It Fa p_name 78The official name of the protocol. 79.It Fa p_aliases 80A zero terminated list of alternative names for the protocol. 81.It Fa p_proto 82The protocol number. 83.El 84.Pp 85The 86.Fn getprotoent 87function 88reads the next line of the file, opening the file if necessary. 89.Pp 90The 91.Fn setprotoent 92function 93opens and rewinds the file. If the 94.Fa stayopen 95flag is non-zero, 96the net data base will not be closed after each call to 97.Fn getprotobyname 98or 99.Fn getprotobynumber . 100.Pp 101The 102.Fn endprotoent 103function 104closes the file. 105.Pp 106The 107.Fn getprotobyname 108function 109and 110.Fn getprotobynumber 111sequentially search from the beginning 112of the file until a matching 113protocol name or 114protocol number is found, 115or until 116.Dv EOF 117is encountered. 118.Sh RETURN VALUES 119Null pointer 120(0) returned on 121.Dv EOF 122or error. 123.Sh FILES 124.Bl -tag -width /etc/protocols -compact 125.It Pa /etc/protocols 126.El 127.Sh SEE ALSO 128.Xr protocols 5 129.Sh HISTORY 130The 131.Fn getprotoent , 132.Fn getprotobynumber , 133.Fn getprotobyname , 134.Fn setprotoent , 135and 136.Fn endprotoent 137functions appeared in 138.Bx 4.2 . 139.Sh BUGS 140These functions use a static data space; 141if the data is needed for future use, it should be 142copied before any subsequent calls overwrite it. 143Only the Internet 144protocols are currently understood. 145