fgetgrent(3) — Linux manual pages

Linux manual pages	Section 3

Name

fgetgrent — get group file entry

Synopsis

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

struct group *fgetgrent( FILE *stream);

Note

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 cause.

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`() .\" FIXME: the following marking is different from which in glibc manual, .\" marking in glibc manual is, .\" fgetgrent: MT-Unsafe race:fgrent .\" We think race:fgrent in glibc maybe hard for users to understand, .\" and have sent a patch to the GNU libc community for changing it to .\" race:fgetgrent, however, something about the copyright impeded the progress.	Thread safety	MT-Unsafe race:fgetgrent

CONFORMING TO

SVr4.

COLOPHON

This page is part of release 4.07 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 https://www.kernel.org/doc/man−pages/.

  Copyright 1993 David Metcalfe (davidprism.demon.co.uk)

%%%LICENSE_START(VERBATIM)
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

Since the Linux kernel and libraries are constantly changing, this
manual page may be incorrect or out-of-date.  The author(s) assume no
responsibility for errors or omissions, or for damages resulting from
the use of the information contained herein.  The author(s) may not
have taken the same level of care in the production of this manual,
which is licensed free of charge, as they might when working
professionally.

Formatted or processed versions of this manual, if unaccompanied by
the source, must acknowledge the copyright and authors of this work.
%%%LICENSE_END

References consulted:
    Linux libc source code
    Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
    386BSD man pages
Modified Sat Jul 24 19:38:44 1993 by Rik Faith (faithcs.unc.edu)

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