FGETGRENT

Section: Linux Programmer's Manual (3)
Updated: 2014-08-19
Index Return to Main Contents

NAME

fgetgrent - get group file entry

SYNOPSIS

#include <stdio.h>
#include <sys/types.h>
#include <grp.h>

struct group *fgetgrent(FILE *stream);

Feature Test Macro Requirements for glibc (see feature_test_macros(7)):

fgetgrent(): _SVID_SOURCE

DESCRIPTION

The fgetgrent() function returns a pointer to a structure containing the group information from the file referred to by stream. The first time it is called it returns the first entry; thereafter, it returns successive entries. The file referred to by stream must have the same format as /etc/group (see group(5)).

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 */
};

RETURN VALUE

The fgetgrent() function returns a pointer to a group structure, or NULL if there are no more entries or an error occurs. In the event of an error, errno is set to indicate the cause.

ERRORS

ENOMEM: Insufficient memory to allocate group structure.

CONFORMING TO

SVr4.

COLOPHON

This page is part of release 4.02 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at http://www.kernel.org/doc/man-pages/.