getgroups(2) - NetBSD Manual Pages

Command:
Section:
Arch:
Collection:
>>>
GETGROUPS(2)              NetBSD Programmer's Manual              GETGROUPS(2)


NAME

     getgroups - get group access list


SYNOPSIS

     #include <sys/types.h>
     #include <unistd.h>

     int
     getgroups(int gidsetlen, gid_t *gidset);


DESCRIPTION

     getgroups() gets the current group access list of the current user pro-
     cess and stores it in the array gidset.  The parameter gidsetlen indi-
     cates the number of entries that may be placed in gidset.  getgroups()
     returns the actual number of groups returned in gidset.  No more than
     {NGROUPS_MAX} will ever be returned.  If gidsetlen is 0, getgroups() re-
     turns the number of groups without modifying the gidset array.


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 errno.


ERRORS

     The possible errors for getgroups() are:

     [EINVAL]      The argument gidsetlen is non-zero and is smaller than the
                   number of groups in the group set.

     [EFAULT]      The argument gidset specifies an invalid address.


SEE ALSO

     setgroups(2), initgroups(3)


STANDARDS

     The getgroups() function conforms to IEEE Std1003.1-1990 (``POSIX'').


HISTORY

     The getgroups() function call appeared in 4.2BSD.

NetBSD 1.4                      April 16, 1994                               1