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