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