original/man3/getprotoent.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\" Modified Sat Jul 24 19:26:03 1993 by Rik Faith (faith@cs.unc.edu)
  30 .TH GETPROTOENT 3  2008-08-19 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 getprotoent, getprotobyname, getprotobynumber, setprotoent,
  33 endprotoent \- get protocol entry
  34 .SH SYNOPSIS
  35 .nf
  36 .B #include <netdb.h>
  37 .sp
  38 .B struct protoent *getprotoent(void);
  39 .sp
  40 .BI "struct protoent *getprotobyname(const char *" name );
  41 .sp
  42 .BI "struct protoent *getprotobynumber(int " proto );
  43 .sp
  44 .BI "void setprotoent(int " stayopen );
  45 .sp
  46 .B void endprotoent(void);
  47 .fi
  48 .SH DESCRIPTION
  49 The
  50 .BR getprotoent ()
  51 function reads the next entry from the protocols database (see
  52 .BR protocols (5))
  53 and returns a
  54 .I protoent
  55 structure
  56 containing the broken-out fields from the entry.
  57 A connection is opened to the database if necessary.
  58 .PP
  59 The
  60 .BR getprotobyname ()
  61 function returns a
  62 .I protoent
  63 structure
  64 for the entry from the database
  65 that matches the protocol name
  66 .IR name .
  67 A connection is opened to the database if necessary.
  68 .PP
  69 The
  70 .BR getprotobynumber ()
  71 function returns a
  72 .I protoent
  73 structure
  74 for the entry from the database
  75 that matches the protocol number
  76 .IR number .
  77 A connection is opened to the database if necessary.
  78 .PP
  79 The
  80 .BR setprotoent ()
  81 function opens a connection to the database,
  82 and sets the next entry to the first entry.
  83 If
  84 .I stayopen
  85 is nonzero,
  86 then the connection to the database
  87 will not be closed between calls to one of the
  88 .BR getproto* ()
  89 functions.
  90 .PP
  91 The
  92 .BR endprotoent ()
  93 function closes the connection to the database.
  94 .PP
  95 The
  96 .I protoent
  97 structure is defined in
  98 .I <netdb.h>
  99 as follows:
 100 .sp
 101 .in +4n
 102 .nf
 103 struct protoent {
 104     char  *p_name;       /* official protocol name */
 105     char **p_aliases;    /* alias list */
 106     int    p_proto;      /* protocol number */
 107 }
 108 .fi
 109 .in
 110 .PP
 111 The members of the
 112 .I protoent
 113 structure are:
 114 .TP
 115 .I p_name
 116 The official name of the protocol.
 117 .TP
 118 .I p_aliases
 119 A NULL-terminated list of alternative names for the protocol.
 120 .TP
 121 .I p_proto
 122 The protocol number.
 123 .SH RETURN VALUE
 124 The
 125 .BR getprotoent (),
 126 .BR getprotobyname ()
 127 and
 128 .BR getprotobynumber ()
 129 functions return a pointer to a
 130 statically allocated
 131 .I protoent
 132 structure, or a null pointer if an
 133 error occurs or the end of the file is reached.
 134 .SH FILES
 135 .PD 0
 136 .TP
 137 .I /etc/protocols
 138 protocol database file
 139 .PD
 140 .SH CONFORMING TO
 141 4.3BSD, POSIX.1-2001.
 142 .SH SEE ALSO
 143 .BR getnetent (3),
 144 .BR getprotoent_r (3),
 145 .BR getservent (3),
 146 .BR protocols (5)
 147 .SH COLOPHON
 148 This page is part of release 3.79 of the Linux
 149 .I man-pages
 150 project.
 151 A description of the project,
 152 information about reporting bugs,
 153 and the latest version of this page,
 154 can be found at
 155 \%http://www.kernel.org/doc/man\-pages/.