1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one.
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date. The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein. The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" References consulted:
24 .\" Linux libc source code
25 .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
28 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
29 .\" Modified 2003-11-15 by aeb
31 .TH GETGRNAM 3 2003-11-15 "" "Linux Programmer's Manual"
33 getgrnam, getgrnam_r, getgrgid, getgrgid_r \- get group file entry
36 .B #include <sys/types.h>
39 .BI "struct group *getgrnam(const char *" name );
41 .BI "struct group *getgrgid(gid_t " gid );
43 .BI "int getgrnam_r(const char *" name ", struct group *" gbuf ,
45 .BI " char *" buf ", size_t " buflen ", struct group **" gbufp );
47 .BI "int getgrgid_r(gid_t " gid ", struct group *" gbuf ,
49 .BI " char *" buf ", size_t " buflen ", struct group **" gbufp );
54 function returns a pointer to a structure containing
55 the broken-out fields of the record in the group database
56 (e.g., the local group file
59 that matches the group name
64 function returns a pointer to a structure containing
65 the broken-out fields of the record in the group database
66 that matches the group ID
73 functions obtain the same information, but store the retrieved
76 in the space pointed to by
80 structure contains pointers to strings, and these strings
81 are stored in the buffer
85 A pointer to the result (in case of success) or NULL (in case no entry
86 was found or an error occurred) is stored in
89 The \fIgroup\fP structure is defined in \fI<grp.h>\fP as follows:
94 char *gr_name; /* group name */
95 char *gr_passwd; /* group password */
96 gid_t gr_gid; /* group ID */
97 char **gr_mem; /* group members */
102 The maximum needed size for
107 .B _SC_GETGR_R_SIZE_MAX
114 functions return a pointer to a
116 structure, or NULL if the matching entry
117 is not found or an error occurs.
120 is set appropriately.
121 If one wants to check
123 after the call, it should be set to zero before the call.
125 The return value may point to static area, and may be overwritten
126 by subsequent calls to
138 In case of error, an error number is returned.
141 .BR 0 " or " ENOENT " or " ESRCH " or " EBADF " or " EPERM " or ... "
157 of files was open already in the calling process.
160 The maximum number of files was open already in the system.
164 Insufficient memory to allocate group structure.
165 .\" to allocate the group structure, or to allocate buffers
168 Insufficient buffer space supplied.
172 local group database file
174 SVr4, 4.3BSD, POSIX.1-2001
176 The formulation given above under "RETURN VALUE" is from POSIX.1-2001.
177 It does not call "not found" an error, hence does not specify what value
179 might have in this situation.
180 But that makes it impossible to recognize
182 One might argue that according to POSIX
184 should be left unchanged if an entry is not found.
185 Experiments on various
186 Unix-like systems shows that lots of different values occur in this
187 situation: 0, ENOENT, EBADF, ESRCH, EWOULDBLOCK, EPERM and probably others.
189 .\" AIX 5.1 - gives ESRCH
190 .\" OSF1 4.0g - gives EWOULDBLOCK
191 .\" libc, glibc, Irix 6.5 - give ENOENT
192 .\" FreeBSD 4.8, OpenBSD 3.2, NetBSD 1.6 - give EPERM
193 .\" SunOS 5.8 - gives EBADF
194 .\" Tru64 5.1b, HP-UX-11i, SunOS 5.7 - give 0