freebsd/lib/libc/sys/getgroups.2

.\" 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
.\" $FreeBSD$
.\"
.Dd March 5, 1999
.Dt GETGROUPS 2
.Os
.Sh NAME
.Nm getgroups
.Nd get group access list
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/types.h
.In unistd.h
.Ft int
.Fn getgroups "int gidsetlen" "gid_t *gidset"
.Sh DESCRIPTION
.Fn Getgroups
gets the current group access list of the 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 zero,
.Fn getgroups
returns the number of supplementary group IDs associated with
the calling process without modifying the array pointed to by
.Fa gidset .
.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 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" 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`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Backed out most of rev.1.4. I didn't submit it; I only submitted a request for it something like it. It was poorly worded and too far from both POSIX wording and normal (mal)practice by referring to sysconf(_SC_NGROUPS_MAX) instead of {NGROUPS_MAX} or NGROUPS. POSIX.1 uses curly braces to mark up "symbolic constants or limits [that may be] defined in certain headers". Since we don't document this markup, don't use it. Just use NGROUPS_MAX. 1999-03-05 10:29:34 +00:00			`.Dd March 5, 1999`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt GETGROUPS 2`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh NAME`
			`.Nm getgroups`
			`.Nd get group access list`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/types.h`
			`.In unistd.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
			`.Fn getgroups "int gidsetlen" "gid_t *gidset"`
			`.Sh DESCRIPTION`
			`.Fn Getgroups`
			`gets the current group access list of the user process`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`and stores it in the array`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Fa gidset .`
			`The parameter`
			`.Fa gidsetlen`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`indicates the number of entries that may be placed in`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Fa gidset .`
			`.Fn Getgroups`
			`returns the actual number of groups returned in`
Backed out most of rev.1.4. I didn't submit it; I only submitted a request for it something like it. It was poorly worded and too far from both POSIX wording and normal (mal)practice by referring to sysconf(_SC_NGROUPS_MAX) instead of {NGROUPS_MAX} or NGROUPS. POSIX.1 uses curly braces to mark up "symbolic constants or limits [that may be] defined in certain headers". Since we don't document this markup, don't use it. Just use NGROUPS_MAX. 1999-03-05 10:29:34 +00:00			`.Fa gidset .`
			`No more than`
			`.Dv NGROUPS_MAX`
			`will ever`
			`be returned.`
Replace sys/param.h with sys/types.h as per POSIX. Document the special case of gidsetlen == 0. Partially obtained from: OpenBSD 1998-01-11 22:01:20 +00:00			`If`
			`.Fa gidsetlen`
			`is zero,`
			`.Fn getgroups`
			`returns the number of supplementary group IDs associated with`
			`the calling process without modifying the array pointed to by`
			`.Fa gidset .`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.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 ,`
Backed out most of rev.1.4. I didn't submit it; I only submitted a request for it something like it. It was poorly worded and too far from both POSIX wording and normal (mal)practice by referring to sysconf(_SC_NGROUPS_MAX) instead of {NGROUPS_MAX} or NGROUPS. POSIX.1 uses curly braces to mark up "symbolic constants or limits [that may be] defined in certain headers". Since we don't document this markup, don't use it. Just use NGROUPS_MAX. 1999-03-05 10:29:34 +00:00			`.Xr initgroups 3`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh HISTORY`
			`The`
Correctly use .Fn instead of .Nm to reference function names in a bunch of man pages. Use the correct .Bx (BSD UNIX) or .At (AT&T UNIX) macros instead of explicitly specifying the version in the text in a bunch of man pages. 1996-08-22 23:31:07 +00:00			`.Fn getgroups`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`function call appeared in`
			`.Bx 4.2 .`