1.\" Copyright (c) 1991, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. All advertising materials mentioning features or use of this software 13.\" must display the following acknowledgement: 14.\" This product includes software developed by the University of 15.\" California, Berkeley and its contributors. 16.\" 4. Neither the name of the University nor the names of its contributors 17.\" may be used to endorse or promote products derived from this software 18.\" without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)getgrouplist.3 8.1 (Berkeley) 6/9/93 33.\" 34.Dd June 9, 1993 35.Dt GETGROUPLIST 3 36.Os 37.Sh NAME 38.Nm getgrouplist 39.Nd calculate group access list 40.Sh SYNOPSIS 41.Fd #include <unistd.h> 42.Ft int 43.Fn getgrouplist "const char *name" "int basegid" "int *groups" "int *ngroups" 44.Sh DESCRIPTION 45The 46.Fn getgrouplist 47function reads through the group file and calculates 48the group access list for the user specified in 49.Fa name . 50The 51.Fa basegid 52is automatically included in the groups list. 53Typically this value is given as 54the group number from the password file. 55.Pp 56The resulting group list is returned in the integer array pointed to by 57.Fa groups . 58The caller specifies the size of the 59.Fa groups 60array in the integer pointed to by 61.Fa ngroups ; 62the actual number of groups found is returned in 63.Fa ngroups . 64.Sh RETURN VALUES 65The 66.Fn getgrouplist 67function 68returns \-1 if the size of the group list is too small to 69hold all the user's groups. 70Here, the group array will be filled with as many groups as will fit. 71.Sh FILES 72.Bl -tag -width /etc/group -compact 73.It Pa /etc/group 74group membership list 75.El 76.Sh SEE ALSO 77.Xr setgroups 2 , 78.Xr initgroups 3 79.Sh HISTORY 80The 81.Fn getgrouplist 82function first appeared in 4.4BSD. 83.Sh BUGS 84The 85.Fn getgrouplist 86function 87uses the routines based on 88.Xr getgrent 3 . 89If the invoking program uses any of these routines, 90the group structure will 91be overwritten in the call to 92.Fn getgrouplist . 93