1.\" $NetBSD: getgroups.2,v 1.14 2001/09/16 01:39:00 wiz Exp $ 2.\" 3.\" Copyright (c) 1983, 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.\" @(#)getgroups.2 8.2 (Berkeley) 4/16/94 35.\" 36.Dd April 16, 1994 37.Dt GETGROUPS 2 38.Os 39.Sh NAME 40.Nm getgroups 41.Nd get group access list 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.Fd #include <sys/types.h> 46.Fd #include <unistd.h> 47.Ft int 48.Fn getgroups "int gidsetlen" "gid_t *gidset" 49.Sh DESCRIPTION 50.Fn getgroups 51gets the current group access list of the current user process 52and stores it in the array 53.Fa gidset . 54The parameter 55.Fa gidsetlen 56indicates the number of entries that may be placed in 57.Fa gidset . 58.Fn getgroups 59returns the actual number of groups returned in 60.Fa gidset . 61No more than 62.Dv {NGROUPS_MAX} 63will ever 64be returned. 65If 66.Fa gidsetlen 67is 0, 68.Fn getgroups 69returns the number of groups without modifying the 70.Fa gidset 71array. 72.Sh RETURN VALUES 73A successful call returns the number of groups in the group set. 74A value of -1 indicates that an error occurred, and the error 75code is stored in the global variable 76.Va errno . 77.Sh ERRORS 78The possible errors for 79.Fn getgroups 80are: 81.Bl -tag -width Er 82.It Bq Er EINVAL 83The argument 84.Fa gidsetlen 85is non-zero and is smaller than the number of groups in the group set. 86.It Bq Er EFAULT 87The argument 88.Fa gidset 89specifies 90an invalid address. 91.El 92.Sh SEE ALSO 93.Xr setgroups 2 , 94.Xr initgroups 3 95.Sh STANDARDS 96The 97.Fn getgroups 98function conforms to 99.St -p1003.1-90 . 100.Sh HISTORY 101The 102.Fn getgroups 103function call appeared in 104.Bx 4.2 . 105