getgrent.3 (revision abd50c55) - OpenGrok cross reference for /original-bsd/lib/libc/gen/getgrent.3

Copyright (c) 1989 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.

@(#)getgrent.3 6.4 (Berkeley) 03/06/89

GETGRENT 3 ""

.AT 3

NAME

getgrent, getgrnam, getgrgid, setgroupent, setgrfile, setgrent, endgrent - get group file entry

SYNOPSIS

 #include <grp.h> 
 struct group *getgrent() 

 struct group *getgrnam(name)  char *name; 

 struct group *getgrgid(gid)  gid_t gid; 

 setgroupent(stayopen)  int stayopen; 

 void setgrfile(name)  char *name; 

 setgrent() 

 void endgrent()

DESCRIPTION

Getgrent, getgrgid and getgrnam each return a pointer to a structure containing the broken-out fields of a line in the group file. This structure is defined by the include file < grp.h >, and contains the following fields:

struct group {
 char *gr_name; /* group name */
 char *gr_passwd; /* group password */
 gid_t gr_gid; /* group id */
 char **gr_mem; /* group members */
};

These fields are more completely described in group (5).

Getgrnam and getgrgid search the group database for a matching group name or group id, respectively, returning the first one encountered. Identical group names or group gids may result in undefined behavior.

Getgrent sequentially reads the group database and is intended for programs that wish to step through the complete list of groups.

All three routines will open the group file for reading, if necesssary.

Setgrfile changes the default group file to file , thus allowing the use of alternate group files.

Setgroupent opens the file, or rewinds it if it is already open. If stayopen is non-zero, file descriptors are left open, significantly speeding up subsequent calls. This functionality is unnecessary for getgrent as it doesn't close its file descriptors by default. It should also be noted that it is dangerous for long-running programs to use this functionality as the group file may be updated.

Setgrent is identical to setgroupent with an argument of zero.

Endgrent closes any open files.

FILES

"SEE ALSO"

getpwent(3), group(5)

DIAGNOSTICS

The routines getgrent , getgrnam , and getgrgid , return a null pointer on EOF or error. Setgroupent and setgrent return 0 on failure, 1 on success. Endgrent and setgrfile have no return value.

BUGS

All information is contained in a static buffer which is overwritten by each new call. It must be copied elsewhere to be retained.

The routines getgrent , endgrent , setgroupent , and setgrent are fairly useless in a networked environment and should be avoided, if possible.