Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

getgroups(2) [opendarwin man page]

GETGROUPS(2)						      BSD System Calls Manual						      GETGROUPS(2)

NAME
getgroups -- get group access list SYNOPSIS
#include <sys/param.h> #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 process 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() returns 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 smaller than the number of groups in the group set. [EFAULT] The argument gidset specifies an invalid address. SEE ALSO
setgroups(2), initgroups(3) HISTORY
The getgroups() function call appeared in 4.2BSD. 4.2 Berkeley Distribution April 16, 1994 4.2 Berkeley Distribution

Check Out this Related Man Page

getgroups(2)							System Calls Manual						      getgroups(2)

NAME
getgroups - get group access list SYNOPSIS
DESCRIPTION
gets the current group access list of the user process and stores it in the array gidset. The parameter ngroups indicates the number of entries which may be placed in gidset. As a special case, if the ngroups argument is zero, returns the number of group entries for the process. In this case, the array pointed to by the gidset argument is not modified. EXAMPLES
The following call to (see getgroups(2)) retrieves the group access list of the calling process and stores the group ids in array mygidset: RETURN VALUE
If successful, returns a non-negative value indicating the number of elements returned in gidset. If an error occurs, a value of -1 is returned and is set to indicate the type of error. ERRORS
fails if any of the following conditions are encountered: gidset specifies an invalid address. The reliable detection of this error is implementation dependent. The argument ngroups is not zero and is less than the number of groups in the current group access list of the process. AUTHOR
was developed by HP and the University of California, Berkeley. SEE ALSO
setgroups(2), sysconf(2), initgroups(3C). STANDARDS CONFORMANCE
getgroups(2)
Man Page