Blame man3/fgetgrent.3

Packit 7cfc04
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
Packit 7cfc04
.\"
Packit 7cfc04
.\" %%%LICENSE_START(VERBATIM)
Packit 7cfc04
.\" Permission is granted to make and distribute verbatim copies of this
Packit 7cfc04
.\" manual provided the copyright notice and this permission notice are
Packit 7cfc04
.\" preserved on all copies.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Permission is granted to copy and distribute modified versions of this
Packit 7cfc04
.\" manual under the conditions for verbatim copying, provided that the
Packit 7cfc04
.\" entire resulting derived work is distributed under the terms of a
Packit 7cfc04
.\" permission notice identical to this one.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Since the Linux kernel and libraries are constantly changing, this
Packit 7cfc04
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
Packit 7cfc04
.\" responsibility for errors or omissions, or for damages resulting from
Packit 7cfc04
.\" the use of the information contained herein.  The author(s) may not
Packit 7cfc04
.\" have taken the same level of care in the production of this manual,
Packit 7cfc04
.\" which is licensed free of charge, as they might when working
Packit 7cfc04
.\" professionally.
Packit 7cfc04
.\"
Packit 7cfc04
.\" Formatted or processed versions of this manual, if unaccompanied by
Packit 7cfc04
.\" the source, must acknowledge the copyright and authors of this work.
Packit 7cfc04
.\" %%%LICENSE_END
Packit 7cfc04
.\"
Packit 7cfc04
.\" References consulted:
Packit 7cfc04
.\"     Linux libc source code
Packit 7cfc04
.\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
Packit 7cfc04
.\"     386BSD man pages
Packit 7cfc04
.\" Modified Sat Jul 24 19:38:44 1993 by Rik Faith (faith@cs.unc.edu)
Packit 7cfc04
.TH FGETGRENT 3  2017-09-15 "GNU" "Linux Programmer's Manual"
Packit 7cfc04
.SH NAME
Packit 7cfc04
fgetgrent \- get group file entry
Packit 7cfc04
.SH SYNOPSIS
Packit 7cfc04
.nf
Packit 7cfc04
.B #include <stdio.h>
Packit 7cfc04
.B #include <sys/types.h>
Packit 7cfc04
.B #include <grp.h>
Packit 7cfc04
.PP
Packit 7cfc04
.BI "struct group *fgetgrent(FILE *" stream );
Packit 7cfc04
.fi
Packit 7cfc04
.PP
Packit 7cfc04
.in -4n
Packit 7cfc04
Feature Test Macro Requirements for glibc (see
Packit 7cfc04
.BR feature_test_macros (7)):
Packit 7cfc04
.in
Packit 7cfc04
.PP
Packit 7cfc04
.BR fgetgrent ():
Packit 7cfc04
    Since glibc 2.19:
Packit 7cfc04
        _DEFAULT_SOURCE
Packit 7cfc04
    Glibc 2.19 and earlier:
Packit 7cfc04
        _SVID_SOURCE
Packit 7cfc04
.SH DESCRIPTION
Packit 7cfc04
The
Packit 7cfc04
.BR fgetgrent ()
Packit 7cfc04
function returns a pointer to a structure containing
Packit 7cfc04
the group information from the file referred to by
Packit 7cfc04
.IR stream .
Packit 7cfc04
The first time it is called
Packit 7cfc04
it returns the first entry; thereafter, it returns successive entries.
Packit 7cfc04
The file referred to by
Packit 7cfc04
.I stream
Packit 7cfc04
must have the same format as
Packit 7cfc04
.I /etc/group
Packit 7cfc04
(see
Packit 7cfc04
.BR group (5)).
Packit 7cfc04
.PP
Packit 7cfc04
The \fIgroup\fP structure is defined in \fI<grp.h>\fP as follows:
Packit 7cfc04
.PP
Packit 7cfc04
.in +4n
Packit 7cfc04
.EX
Packit 7cfc04
struct group {
Packit 7cfc04
    char   *gr_name;        /* group name */
Packit 7cfc04
    char   *gr_passwd;      /* group password */
Packit 7cfc04
    gid_t   gr_gid;         /* group ID */
Packit 7cfc04
    char  **gr_mem;         /* NULL-terminated array of pointers
Packit 7cfc04
                               to names of group members */
Packit 7cfc04
};
Packit 7cfc04
.EE
Packit 7cfc04
.in
Packit 7cfc04
.SH RETURN VALUE
Packit 7cfc04
The
Packit 7cfc04
.BR fgetgrent ()
Packit 7cfc04
function returns a pointer to a
Packit 7cfc04
.I group
Packit 7cfc04
structure,
Packit 7cfc04
or NULL if there are no more entries or an error occurs.
Packit 7cfc04
In the event of an error,
Packit 7cfc04
.I errno
Packit 7cfc04
is set to indicate the cause.
Packit 7cfc04
.SH ERRORS
Packit 7cfc04
.TP
Packit 7cfc04
.B ENOMEM
Packit 7cfc04
Insufficient memory to allocate
Packit 7cfc04
.I group
Packit 7cfc04
structure.
Packit 7cfc04
.SH ATTRIBUTES
Packit 7cfc04
For an explanation of the terms used in this section, see
Packit 7cfc04
.BR attributes (7).
Packit 7cfc04
.TS
Packit 7cfc04
allbox;
Packit 7cfc04
lb lb lb
Packit 7cfc04
l l l.
Packit 7cfc04
Interface	Attribute	Value
Packit 7cfc04
T{
Packit 7cfc04
.BR fgetgrent ()
Packit 7cfc04
T}	Thread safety	MT-Unsafe race:fgetgrent
Packit 7cfc04
.TE
Packit 7cfc04
.\" FIXME The marking is different from that in the glibc manual,
Packit 7cfc04
.\" which has:
Packit 7cfc04
.\"
Packit 7cfc04
.\"    fgetgrent: MT-Unsafe race:fgrent
Packit 7cfc04
.\"
Packit 7cfc04
.\" We think race:fgrent in glibc may be hard for users to understand,
Packit 7cfc04
.\" and have sent a patch to the GNU libc community for changing it to
Packit 7cfc04
.\" race:fgetgrent, however, something about the copyright impeded the
Packit 7cfc04
.\" progress.
Packit 7cfc04
.SH CONFORMING TO
Packit 7cfc04
SVr4.
Packit 7cfc04
.SH SEE ALSO
Packit 7cfc04
.BR endgrent (3),
Packit 7cfc04
.BR fgetgrent_r (3),
Packit 7cfc04
.BR fopen (3),
Packit 7cfc04
.BR getgrent (3),
Packit 7cfc04
.BR getgrgid (3),
Packit 7cfc04
.BR getgrnam (3),
Packit 7cfc04
.BR putgrent (3),
Packit 7cfc04
.BR setgrent (3),
Packit 7cfc04
.BR group (5)
Packit 7cfc04
.SH COLOPHON
Packit 7cfc04
This page is part of release 4.15 of the Linux
Packit 7cfc04
.I man-pages
Packit 7cfc04
project.
Packit 7cfc04
A description of the project,
Packit 7cfc04
information about reporting bugs,
Packit 7cfc04
and the latest version of this page,
Packit 7cfc04
can be found at
Packit 7cfc04
\%https://www.kernel.org/doc/man\-pages/.