1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date. The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein. The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" References consulted:
26 .\" Linux libc source code
27 .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
29 .\" Modified Sat Jul 24 19:29:54 1993 by Rik Faith (faith@cs.unc.edu)
30 .TH GETGRENT 3 2021-03-22 "" "Linux Programmer's Manual"
32 getgrent, setgrent, endgrent \- get group file entry
35 .B #include <sys/types.h>
38 .B struct group *getgrent(void);
40 .B void setgrent(void);
41 .B void endgrent(void);
45 Feature Test Macro Requirements for glibc (see
46 .BR feature_test_macros (7)):
52 .\" || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
53 || /* Glibc since 2.19: */ _DEFAULT_SOURCE
54 || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
61 _XOPEN_SOURCE >= 500 || _DEFAULT_SOURCE
62 .\" || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
63 Glibc 2.21 and earlier
65 .\" || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
66 || /* Since glibc 2.12: */ _POSIX_C_SOURCE >= 200809L
67 || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
72 function returns a pointer to a structure containing
73 the broken-out fields of a record in the group database
74 (e.g., the local group file
80 it returns the first entry; thereafter, it returns successive entries.
84 function rewinds to the beginning
85 of the group database, to allow repeated scans.
89 function is used to close the group database
90 after all processing has been performed.
92 The \fIgroup\fP structure is defined in \fI<grp.h>\fP as follows:
97 char *gr_name; /* group name */
98 char *gr_passwd; /* group password */
99 gid_t gr_gid; /* group ID */
100 char **gr_mem; /* NULL\-terminated array of pointers
101 to names of group members */
106 For more information about the fields of this structure, see
111 function returns a pointer to a
114 or NULL if there are no more entries or an error occurs.
119 If one wants to check
121 after the call, it should be set to zero before the call.
123 The return value may point to a static area, and may be overwritten
124 by subsequent calls to
129 (Do not pass the returned pointer to
134 The service was temporarily unavailable; try again later.
135 For NSS backends in glibc this indicates a temporary error talking to the backend.
136 The error may correct itself, retrying later is suggested.
139 A signal was caught; see
146 The per-process limit on the number of open file descriptors has been reached.
149 The system-wide limit on the total number of open files has been reached.
153 A necessary input file cannot be found.
154 For NSS backends in glibc this indicates the backend is not correctly configured.
158 Insufficient memory to allocate
163 Insufficient buffer space supplied.
167 local group database file
169 For an explanation of the terms used in this section, see
177 Interface Attribute Value
188 MT-Unsafe race:grent locale
199 signifies that if any of the functions
204 are used in parallel in different threads of a program,
205 then data races could occur.
207 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
213 .BR getgrouplist (3),