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.\" $FreeBSD$ 34.\" 35.Dd June 9, 1993 36.Dt GETGROUPLIST 3 37.Os 38.Sh NAME 39.Nm getgrouplist 40.Nd calculate group access list 41.Sh SYNOPSIS 42.Fd #include <unistd.h> 43.Ft int 44.Fn getgrouplist "const char *name" "int basegid" "int *groups" "int *ngroups" 45.Sh DESCRIPTION 46The 47.Fn getgrouplist 48function reads through the group file and calculates 49the group access list for the user specified in 50.Fa name . 51The 52.Fa basegid 53is automatically included in the groups list. 54Typically this value is given as 55the group number from the password file. 56.Pp 57The resulting group list is returned in the integer array pointed to by 58.Fa groups . 59The caller specifies the size of the 60.Fa groups 61array in the integer pointed to by 62.Fa ngroups ; 63the actual number of groups found is returned in 64.Fa ngroups . 65.Sh RETURN VALUES 66The 67.Fn getgrouplist 68function 69returns \-1 if the size of the group list is too small to 70hold all the user's groups. 71Here, the group array will be filled with as many groups as will fit. 72.Sh FILES 73.Bl -tag -width /etc/group -compact 74.It Pa /etc/group 75group membership list 76.El 77.Sh SEE ALSO 78.Xr setgroups 2 , 79.Xr initgroups 3 80.Sh HISTORY 81The 82.Fn getgrouplist 83function first appeared in 84.Bx 4.4 . 85.Sh BUGS 86The 87.Fn getgrouplist 88function 89uses the routines based on 90.Xr getgrent 3 . 91If the invoking program uses any of these routines, 92the group structure will 93be overwritten in the call to 94.Fn getgrouplist . 95