libc/gen/getgrent.3

         @(#)getgrent.3 4.1 (Berkeley) 05/15/85

 GETGRENT 3
.AT 3
 NAME
getgrent, getgrgid, getgrnam, setgrent, endgrent - get group file entry
 SYNOPSIS
 #include <grp.h>
 struct group *getgrent()
 struct group *getgrgid(gid)  int gid;
 struct group *getgrnam(name)  char *name;
 setgrent()
 endgrent()
 DESCRIPTION
 Getgrent,  getgrgid and
 getgrnam each return pointers
to an object
with the following structure
containing the broken-out
fields of a line in the group file.


.so  /usr/include/grp.h


The members of this structure are:
 \w'gr_passwd'u+2n
gr_name
The name of the group.

.ns
 \w'gr_passwd'u+2n
gr_passwd
The encrypted password of the group.

.ns
 \w'gr_passwd'u+2n
gr_gid
The numerical group-ID.

.ns
 \w'gr_passwd'u+2n
gr_mem
Null-terminated vector
of pointers to the individual
member names.

 Getgrent simply reads the next
line while
 getgrgid and
 getgrnam search until a matching
 gid or
 name is found
(or until EOF is encountered).
Each routine picks up
where the others leave off
so successive calls may be used
to search the entire file.

A call to
 setgrent has the effect of rewinding
the group file
to allow
repeated searches.
 Endgrent may be called to
close the group file
when processing is complete.
 FILES
/etc/group
 "SEE ALSO"
getlogin(3), getpwent(3), group(5)
 DIAGNOSTICS
A null pointer
(0) is 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.