getgrent(3C)
get group file entry
From the original Amiga UNIX 2.1 manual. Some things it mentions may not be in this release.
NAME
getgrent, getgrgid, getgrnam, setgrent, endgrent, fgetgrent - get group file entry
SYNOPSIS
#include <grp.h> struct group *getgrent (void); struct group *getgrgid (gid_t gid); struct group *getgrnam (const char *name); void setgrent (void); void endgrent (void); struct group *fgetgrent (FILE *f);
DESCRIPTION
getgrent, getgrgid, and getgrnam each return pointers to an
object containing the broken-out fields of a line in the
/etc/group file. Each line contains a ``group'' structure,
defined in the grp.h header file with the following members:
char *gr_name; /* the name of the group */
char *gr_passwd; /* the encrypted group password */
gid_t gr_gid; /* the numerical group ID */
char **gr_mem; /* vector of pointers to member names */
When first called, getgrent returns a pointer to the first
group structure in the file; thereafter, it returns a
pointer to the next group structure in the file; so, succes-
sive calls may be used to search the entire file. getgrgid
searches from the beginning of the file until a numerical
group id matching gid is found and returns a pointer to the
particular structure in which it was found.
getgrnam searches from the beginning of the file until a group name matching name is found and returns a pointer to the particular structure in which it was found. If an endof-file or an error is encountered on reading, these functions return a null pointer.
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.
fgetgrent returns a pointer to the next group structure in the stream f, which matches the format of /etc/group.
FILES
/etc/group
SEE ALSO
getlogin(3C), getpwent(3C). group(4) in the System Administrator's Reference Manual.
DIAGNOSTICS
getgrent, getgrgid, getgrnam, and fgetgrent return a null pointer on EOF or error.
NOTES
All information is contained in a static area, so it must be copied if it is to be saved.