]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk) |
2 | .\" | |
93015253 | 3 | .\" %%%LICENSE_START(VERBATIM) |
fea681da MK |
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. | |
7 | .\" | |
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. | |
c13182ef | 12 | .\" |
fea681da MK |
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 | |
19 | .\" professionally. | |
c13182ef | 20 | .\" |
fea681da MK |
21 | .\" Formatted or processed versions of this manual, if unaccompanied by |
22 | .\" the source, must acknowledge the copyright and authors of this work. | |
4b72fb64 | 23 | .\" %%%LICENSE_END |
fea681da MK |
24 | .\" |
25 | .\" References consulted: | |
26 | .\" Linux libc source code | |
27 | .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991) | |
28 | .\" 386BSD man pages | |
29 | .\" Modified Sat Jul 24 19:38:44 1993 by Rik Faith (faith@cs.unc.edu) | |
4b8c67d9 | 30 | .TH FGETGRENT 3 2017-09-15 "GNU" "Linux Programmer's Manual" |
fea681da MK |
31 | .SH NAME |
32 | fgetgrent \- get group file entry | |
33 | .SH SYNOPSIS | |
34 | .nf | |
35 | .B #include <stdio.h> | |
36 | .B #include <sys/types.h> | |
37 | .B #include <grp.h> | |
68e4db0a | 38 | .PP |
fea681da MK |
39 | .BI "struct group *fgetgrent(FILE *" stream ); |
40 | .fi | |
68e4db0a | 41 | .PP |
cc4615cc MK |
42 | .in -4n |
43 | Feature Test Macro Requirements for glibc (see | |
44 | .BR feature_test_macros (7)): | |
45 | .in | |
68e4db0a | 46 | .PP |
cc4615cc | 47 | .BR fgetgrent (): |
51c612fb MK |
48 | Since glibc 2.19: |
49 | _DEFAULT_SOURCE | |
50 | Glibc 2.19 and earlier: | |
51 | _SVID_SOURCE | |
fea681da | 52 | .SH DESCRIPTION |
60a90ecd MK |
53 | The |
54 | .BR fgetgrent () | |
55 | function returns a pointer to a structure containing | |
fb3dcb4a MK |
56 | the group information from the file referred to by |
57 | .IR stream . | |
c13182ef MK |
58 | The first time it is called |
59 | it returns the first entry; thereafter, it returns successive entries. | |
fb3dcb4a MK |
60 | The file referred to by |
61 | .I stream | |
62 | must have the same format as | |
63 | .I /etc/group | |
64 | (see | |
65 | .BR group (5)). | |
fea681da MK |
66 | .PP |
67 | The \fIgroup\fP structure is defined in \fI<grp.h>\fP as follows: | |
51f5698d | 68 | .PP |
bd191423 | 69 | .in +4n |
b8302363 | 70 | .EX |
fea681da | 71 | struct group { |
cc4615cc MK |
72 | char *gr_name; /* group name */ |
73 | char *gr_passwd; /* group password */ | |
74 | gid_t gr_gid; /* group ID */ | |
b7800b44 MK |
75 | char **gr_mem; /* NULL-terminated array of pointers |
76 | to names of group members */ | |
fea681da | 77 | }; |
b8302363 | 78 | .EE |
bd191423 | 79 | .in |
47297adb | 80 | .SH RETURN VALUE |
60a90ecd MK |
81 | The |
82 | .BR fgetgrent () | |
55a18b78 MK |
83 | function returns a pointer to a |
84 | .I group | |
85 | structure, | |
fea681da | 86 | or NULL if there are no more entries or an error occurs. |
3600608b MK |
87 | In the event of an error, |
88 | .I errno | |
89 | is set to indicate the cause. | |
fea681da MK |
90 | .SH ERRORS |
91 | .TP | |
92 | .B ENOMEM | |
55a18b78 MK |
93 | Insufficient memory to allocate |
94 | .I group | |
95 | structure. | |
098cd28b ZL |
96 | .SH ATTRIBUTES |
97 | For an explanation of the terms used in this section, see | |
98 | .BR attributes (7). | |
99 | .TS | |
100 | allbox; | |
101 | lb lb lb | |
102 | l l l. | |
103 | Interface Attribute Value | |
104 | T{ | |
105 | .BR fgetgrent () | |
098cd28b ZL |
106 | T} Thread safety MT-Unsafe race:fgetgrent |
107 | .TE | |
13ce9c8d MK |
108 | .\" FIXME The marking is different from that in the glibc manual, |
109 | .\" which has: | |
110 | .\" | |
111 | .\" fgetgrent: MT-Unsafe race:fgrent | |
112 | .\" | |
113 | .\" We think race:fgrent in glibc may be hard for users to understand, | |
114 | .\" and have sent a patch to the GNU libc community for changing it to | |
d07f4209 MK |
115 | .\" race:fgetgrent, however, something about the copyright impeded the |
116 | .\" progress. | |
47297adb | 117 | .SH CONFORMING TO |
44a2c328 | 118 | SVr4. |
47297adb | 119 | .SH SEE ALSO |
fea681da MK |
120 | .BR endgrent (3), |
121 | .BR fgetgrent_r (3), | |
fb3dcb4a | 122 | .BR fopen (3), |
fea681da MK |
123 | .BR getgrent (3), |
124 | .BR getgrgid (3), | |
125 | .BR getgrnam (3), | |
c9c3b6f3 | 126 | .BR putgrent (3), |
fb3dcb4a | 127 | .BR setgrent (3), |
60e91186 | 128 | .BR group (5) |