xref: /original-bsd/lib/libc/net/getnetent.3 (revision b0ceb3f2)
Copyright (c) 1983 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)getnetent.3 6.4 (Berkeley) 02/14/89

GETNETENT 3 ""
C 5
NAME
getnetent, getnetbyaddr, getnetbyname, setnetent, endnetent - get network entry
SYNOPSIS
#include <netdb.h>

struct netent *getnetent()

struct netent *getnetbyname(name) char *name;

struct netent *getnetbyaddr(net, type) long net; int type;

setnetent(stayopen) int stayopen;

endnetent()

DESCRIPTION
Getnetent , getnetbyname , and getnetbyaddr each return a pointer to an object with the following structure containing the broken-out fields of a line in the network data base, /etc/networks .

struct netent {
 char *n_name; /* official name of net */
 char **n_aliases; /* alias list */
 int n_addrtype; /* net number type */
 unsigned long n_net; /* net number */
};

The members of this structure are:

\w'n_addrtype'u+2n n_name The official name of the network.

\w'n_addrtype'u+2n n_aliases A zero terminated list of alternate names for the network.

\w'n_addrtype'u+2n n_addrtype The type of the network number returned; currently only AF_INET.

\w'n_addrtype'u+2n n_net The network number. Network numbers are returned in machine byte order.

Getnetent reads the next line of the file, opening the file if necessary.

Setnetent opens and rewinds the file. If the stayopen flag is non-zero, the net data base will not be closed after each call to getnetbyname or getnetbyaddr .

Endnetent closes the file.

Getnetbyname and getnetbyaddr sequentially search from the beginning of the file until a matching net name or net address and type is found, or until EOF is encountered. Network numbers are supplied in host order.

FILES
/etc/networks
"SEE ALSO"
networks(5)
DIAGNOSTICS
Null pointer (0) returned on EOF or error.
BUGS
All information is contained in a static area so it must be copied if it is to be saved. Only Internet network numbers are currently understood. Expecting network numbers to fit in no more than 32 bits is probably naive.