1.\" Copyright (c) 1983, 1991 The Regents of the University of California. 2.\" 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.\" @(#)getgroups.2 6.7 (Berkeley) 3/10/91 33.\" 34.Dd March 10, 1991 35.Dt GETGROUPS 2 36.Os BSD 4.2 37.Sh NAME 38.Nm getgroups 39.Nd get group access list 40.Sh SYNOPSIS 41.Fd #include <sys/param.h> 42.Fd #include <unistd.h> 43.Ft int 44.Fn getgroups "int gidsetlen" "int *gidset" 45.Sh DESCRIPTION 46.Fn Getgroups 47gets the current group access list of the user process 48and stores it in the array 49.Fa gidset . 50The parameter 51.Fa gidsetlen 52indicates the number of entries that may be placed in 53.Fa gidset . 54.Fn Getgroups 55returns the actual number of groups returned in 56.Fa gidset . 57No more than 58.Dv NGROUPS , 59as defined in 60.Aq Pa sys/param.h , 61will ever 62be returned. 63.Sh RETURN VALUES 64A successful call returns the number of groups in the group set. 65A value of -1 indicates that an error occurred, and the error 66code is stored in the global variable 67.Va errno . 68.Sh ERRORS 69The possible errors for 70.Fn getgroups 71are: 72.Bl -tag -width Er 73.It Bq Er EINVAL 74The argument 75.Fa gidsetlen 76is smaller than the number of groups in the group set. 77.It Bq Er EFAULT 78The argument 79.Fa gidset 80specifies 81an invalid address. 82.El 83.Sh SEE ALSO 84.Xr setgroups 2 , 85.Xr initgroups 3 86.Sh BUGS 87The 88.Fa gidset 89array should be of type 90.Vt gid_t , 91but remains integer for compatibility with earlier systems. 92.Sh HISTORY 93The 94.Nm 95function call appeared in 96.Bx 4.2 . 97