qgetgrent.3

NAME

qgetgrent, qsetgrent, qendgrent - get group file entry

SYNOPSIS

#include <sys/types.h>
#include <qgetpwgr.h>

struct group *qgetgrent(void);

void qsetgrent(void);

void qendgrent(void);

DESCRIPTION

The qgetgrent() function returns a pointer to a structure containing the broken-out fields of a record in the group database (the local group file /etc/group, ). The first time qgetgrent() is called, it returns the first entry; thereafter, it returns successive entries.

The qsetgrent() function rewinds to the beginning of the group database, to allow repeated scans.

The qendgrent() function is used to close the group database after all processing has been performed.

The group structure is defined in <grp.h> as follows:

struct group {
    char   *gr_name;        /* group name */
    char   *gr_passwd;      /* group password */
    gid_t   gr_gid;         /* group ID */
    char  **gr_mem;         /* NULL-terminated array of pointers
                               to names of group members */
};

For more information about the fields of this structure, see group(5).

RETURN VALUE

The qgetgrent() function returns a pointer to a group structure, or NULL if there are no more entries or an error occurs.

Upon error, errno may be set. If one wants to check errno after the call, it should be set to zero before the call.

The return value may point to a static area, and may be overwritten by subsequent calls to qgetgrent(), qgetgrgid(3), or qgetgrnam(3). (Do not pass the returned pointer to free(3).)

ERRORS

EINTR
A signal was caught; see signal(7).

ENOENT
A necessary input file cannot be found

ENOMEM
Insufficient memory to allocate group structure.

ERANGE
Insufficient buffer space supplied.

ETXTBUSY
Temporary error happened.

FILES

/etc/group
local group database file

SEE ALSO

qgetgrent_r(3), qgetgrgid(3), qgetgrnam(3), grpscan(3), group(5)