]>
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) | |
6f3c74a8 | 30 | .TH FGETGRENT 3 2015-12-05 "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> | |
38 | .sp | |
39 | .BI "struct group *fgetgrent(FILE *" stream ); | |
40 | .fi | |
cc4615cc MK |
41 | .sp |
42 | .in -4n | |
43 | Feature Test Macro Requirements for glibc (see | |
44 | .BR feature_test_macros (7)): | |
45 | .in | |
46 | .sp | |
47 | .BR fgetgrent (): | |
48 | _SVID_SOURCE | |
fea681da | 49 | .SH DESCRIPTION |
60a90ecd MK |
50 | The |
51 | .BR fgetgrent () | |
52 | function returns a pointer to a structure containing | |
fb3dcb4a MK |
53 | the group information from the file referred to by |
54 | .IR stream . | |
c13182ef MK |
55 | The first time it is called |
56 | it returns the first entry; thereafter, it returns successive entries. | |
fb3dcb4a MK |
57 | The file referred to by |
58 | .I stream | |
59 | must have the same format as | |
60 | .I /etc/group | |
61 | (see | |
62 | .BR group (5)). | |
fea681da MK |
63 | .PP |
64 | The \fIgroup\fP structure is defined in \fI<grp.h>\fP as follows: | |
65 | .sp | |
bd191423 | 66 | .in +4n |
fea681da | 67 | .nf |
fea681da | 68 | struct group { |
cc4615cc MK |
69 | char *gr_name; /* group name */ |
70 | char *gr_passwd; /* group password */ | |
71 | gid_t gr_gid; /* group ID */ | |
b7800b44 MK |
72 | char **gr_mem; /* NULL-terminated array of pointers |
73 | to names of group members */ | |
fea681da | 74 | }; |
fea681da | 75 | .fi |
bd191423 | 76 | .in |
47297adb | 77 | .SH RETURN VALUE |
60a90ecd MK |
78 | The |
79 | .BR fgetgrent () | |
55a18b78 MK |
80 | function returns a pointer to a |
81 | .I group | |
82 | structure, | |
fea681da | 83 | or NULL if there are no more entries or an error occurs. |
3600608b MK |
84 | In the event of an error, |
85 | .I errno | |
86 | is set to indicate the cause. | |
fea681da MK |
87 | .SH ERRORS |
88 | .TP | |
89 | .B ENOMEM | |
55a18b78 MK |
90 | Insufficient memory to allocate |
91 | .I group | |
92 | structure. | |
098cd28b ZL |
93 | .SH ATTRIBUTES |
94 | For an explanation of the terms used in this section, see | |
95 | .BR attributes (7). | |
96 | .TS | |
97 | allbox; | |
98 | lb lb lb | |
99 | l l l. | |
100 | Interface Attribute Value | |
101 | T{ | |
102 | .BR fgetgrent () | |
103 | .\" FIXME: the following marking is different from which in glibc manual, | |
104 | .\" marking in glibc manual is, | |
105 | .\" fgetgrent: MT-Unsafe race:fgrent | |
106 | .\" We think race:fgrent in glibc maybe hard for users to understand, | |
107 | .\" and have sent a patch to the GNU libc community for changing it to | |
108 | .\" race:fgetgrent, however, something about the copyright impeded the progress. | |
109 | T} Thread safety MT-Unsafe race:fgetgrent | |
110 | .TE | |
111 | ||
47297adb | 112 | .SH CONFORMING TO |
44a2c328 | 113 | SVr4. |
47297adb | 114 | .SH SEE ALSO |
fea681da MK |
115 | .BR endgrent (3), |
116 | .BR fgetgrent_r (3), | |
fb3dcb4a | 117 | .BR fopen (3), |
fea681da MK |
118 | .BR getgrent (3), |
119 | .BR getgrgid (3), | |
120 | .BR getgrnam (3), | |
c9c3b6f3 | 121 | .BR putgrent (3), |
fb3dcb4a | 122 | .BR setgrent (3), |
60e91186 | 123 | .BR group (5) |