fgetgrent(3) — Linux manual page

fgetgrent(3)            Library Functions Manual            fgetgrent(3)

NAME

       fgetgrent - get group file entry

LIBRARY

       Standard C library (libc, -lc)

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():
           Since glibc 2.19:
               _DEFAULT_SOURCE
           glibc 2.19 and earlier:
               _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 error.

ERRORS

       ENOMEM Insufficient memory to allocate group structure.

ATTRIBUTES

       For an explanation of the terms used in this section, see
       attributes(7).
       ┌────────────────────┬───────────────┬──────────────────────────┐
       │ Interface          │ Attribute     │ Value                    │
       ├────────────────────┼───────────────┼──────────────────────────┤
       │ fgetgrent()        │ Thread safety │ MT-Unsafe race:fgetgrent │
       └────────────────────┴───────────────┴──────────────────────────┘

STANDARDS

       None.

HISTORY

       SVr4.

SEE ALSO

       endgrent(3), fgetgrent_r(3), fopen(3), getgrent(3), getgrgid(3),
       getgrnam(3), putgrent(3), setgrent(3), group(5)

COLOPHON

       This page is part of the man-pages (Linux kernel and C library
       user-space interface documentation) project.  Information about
       the project can be found at 
       ⟨https://www.kernel.org/doc/man-pages/⟩.  If you have a bug report
       for this manual page, see
       ⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
       This page was obtained from the tarball man-pages-6.9.1.tar.gz
       fetched from
       ⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
       2024-06-26.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

Linux man-pages 6.9.1          2024-05-02                   fgetgrent(3)

Pages that refer to this page: getgrent(3), getgrent_r(3), getgrnam(3), putgrent(3)

---