[apple/xnu.git] / bsd / man / man2 / getgroups.2

.\"	$NetBSD: getgroups.2,v 1.8 1995/02/27 12:32:57 cgd Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)getgroups.2	8.2 (Berkeley) 4/16/94
.\"
.Dd April 16, 1994
.Dt GETGROUPS 2
.Os BSD 4.2
.Sh NAME
.Nm getgroups
.Nd get group access list
.Sh SYNOPSIS
.Fd #include <unistd.h>
.Ft int
.Fo getgroups
.Fa "int gidsetsize"
.Fa "gid_t grouplist[]"
.Fc
.Sh DESCRIPTION
.Fn Getgroups
gets the current group access list of the current user process
and stores it in the array 
.Fa grouplist[] .
The parameter
.Fa gidsetsize
indicates the number of entries that may be placed in 
.Fa grouplist[] .
.Fn Getgroups
returns the actual number of groups returned in
.Fa grouplist[] .
No more than
.Dv {NGROUPS_MAX}
will ever
be returned.
If
.Fa gidsetsize
is 0, 
.Fn getgroups
returns the number of groups without modifying the
.Fa grouplist[]
array.
.Sh RETURN VALUES
A successful call returns the number of groups in the group set.
Otherwise, a value of -1 is returned and the global integer variable
.Va errno
is set to indicate the error.
.Sh ERRORS
The possible errors for
.Fn getgroups
are:
.Bl -tag -width Er
.\" ==========
.It Bq Er EFAULT
The argument
.Fa grouplist
specifies an invalid address.
.\" ==========
.It Bq Er EINVAL
The argument
.Fa gidsetsize ,
although non-zero,
is smaller than the number of groups in the group set.
.El
.Sh LEGACY SYNOPSIS
.Fd #include <sys/param.h>
.Fd #include <sys/types.h>
.Fd #include <unistd.h>
.Pp
The include files
.In sys/param.h
and
.In sys/types.h
are necessary.
.Sh SEE ALSO
.Xr setgroups 2 ,
.Xr initgroups 3 ,
.Xr compat 5
.Sh HISTORY
The
.Fn getgroups
function call appeared in
.Bx 4.2 .
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: getgroups.2,v 1.8 1995/02/27 12:32:57 cgd 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
9bccf70c A	43	.Fd #include <unistd.h>
9bccf70c A	44	.Ft int
2d21ac55 A	45	.Fo getgroups
	46	.Fa "int gidsetsize"
	47	.Fa "gid_t grouplist[]"
	48	.Fc
9bccf70c A	49	.Sh DESCRIPTION
	50	.Fn Getgroups
	51	gets the current group access list of the current user process
	52	and stores it in the array
2d21ac55	53	.Fa grouplist[] .
9bccf70c	54	The parameter
2d21ac55	55	.Fa gidsetsize
9bccf70c	56	indicates the number of entries that may be placed in
2d21ac55	57	.Fa grouplist[] .
9bccf70c A	58	.Fn Getgroups
9bccf70c A	59	returns the actual number of groups returned in
2d21ac55	60	.Fa grouplist[] .
9bccf70c A	61	No more than
	62	.Dv {NGROUPS_MAX}
	63	will ever
	64	be returned.
	65	If
2d21ac55	66	.Fa gidsetsize
9bccf70c A	67	is 0,
	68	.Fn getgroups
	69	returns the number of groups without modifying the
2d21ac55	70	.Fa grouplist[]
9bccf70c A	71	array.
	72	.Sh RETURN VALUES
	73	A successful call returns the number of groups in the group set.
2d21ac55 A	74	Otherwise, a value of -1 is returned and the global integer variable
	75	.Va errno
	76	is set to indicate the error.
9bccf70c A	77	.Sh ERRORS
	78	The possible errors for
	79	.Fn getgroups
	80	are:
	81	.Bl -tag -width Er
2d21ac55 A	82	.\" ==========
	83	.It Bq Er EFAULT
	84	The argument
	85	.Fa grouplist
	86	specifies an invalid address.
	87	.\" ==========
9bccf70c A	88	.It Bq Er EINVAL
9bccf70c A	89	The argument
2d21ac55 A	90	.Fa gidsetsize ,
2d21ac55 A	91	although non-zero,
9bccf70c	92	is smaller than the number of groups in the group set.
9bccf70c	93	.El
2d21ac55 A	94	.Sh LEGACY SYNOPSIS
	95	.Fd #include <sys/param.h>
	96	.Fd #include <sys/types.h>
	97	.Fd #include <unistd.h>
	98	.Pp
	99	The include files
	100	.In sys/param.h
	101	and
	102	.In sys/types.h
	103	are necessary.
9bccf70c A	104	.Sh SEE ALSO
9bccf70c A	105	.Xr setgroups 2 ,
2d21ac55 A	106	.Xr initgroups 3 ,
2d21ac55 A	107	.Xr compat 5
9bccf70c A	108	.Sh HISTORY
	109	The
	110	.Fn getgroups
	111	function call appeared in
	112	.Bx 4.2 .