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