NAME
getgroups, setgroups - get/set list of supplementary group IDs
SYNOPSIS
#include <sys/types.h>
#include <unistd.h>
I int getgroups(int size , gid_t list []);
#include <grp.h>
I int setgroups(size_t size , const gid_t * list );
DESCRIPTION
R getgroups ()
Up to
size
supplementary group IDs (of the calling process) are returned in
R list .
It is unspecified whether the effective group ID of the calling process
is included in the returned list.
(Thus, an application should also call
getegid(2)
and add or remove the resulting value.)
If
size
is zero,
list
is not modified, but the total number of supplementary group IDs for the
process is returned.
R setgroups ()
Sets the supplementary group IDs for the process.
Appropriate privileges (Linux: the
CAP_SETGID
capability) are required.
RETURN VALUE
R getgroups ()
On success, the number of supplementary group IDs is returned.
On error, -1 is returned, and
errno
is set appropriately.
R setgroups ()
On success, zero is returned.
On error, -1 is returned, and
errno
is set appropriately.
ERRORS
EFAULT
list
has an invalid address.
EINVAL
For
R setgroups (),
size
is greater than
NGROUPS
(32 for Linux 2.0.32).
For
R getgroups (),
size
is less than the number of supplementary group IDs, but is not zero.
EPERM
The calling process has insufficient privilege to call
R setgroups ().
CONFORMING TO
SVr4, 4.3BSD.
The
R getgroups ()
function is in POSIX.1-2001.
Since
R setgroups ()
requires privilege, it is not covered by POSIX.1-2001.
NOTES
A process can have up to at least
NGROUPS_MAX
supplementary group IDs
in addition to the effective group ID.
The set of supplementary group IDs
is inherited from the parent process and may be changed using
R setgroups ().
The maximum number of supplementary group IDs can be found using
sysconf(3):
long ngroups_max;
ngroups_max = sysconf(_SC_NGROUPS_MAX);
The maximal return value of
R getgroups ()
cannot be larger than one more than the value obtained this way.
The prototype for
R setgroups ()
is only available if
_BSD_SOURCE
is defined.
SEE ALSO