Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

getgroups(2) [freebsd man page]

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

NAME
getgroups -- get group access list LIBRARY
Standard C Library (libc, -lc) SYNOPSIS
#include <unistd.h> int getgroups(int gidsetlen, gid_t *gidset); DESCRIPTION
The getgroups() system call gets the current group access list of the user process and stores it in the array gidset. The gidsetlen argument indicates the number of entries that may be placed in gidset. The getgroups() system call returns the actual number of groups returned in gidset. At least one and as many as {NGROUPS_MAX}+1 values may be returned. If gidsetlen is zero, getgroups() returns the number of supple- mentary group IDs associated with the calling process without modifying the array pointed to by gidset. The value of {NGROUPS_MAX} should be obtained using sysconf(3) to avoid hard-coding it into the executable. 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), sysconf(3) STANDARDS
The getgroups() system call conforms to IEEE Std 1003.1-2008 (``POSIX.1''). HISTORY
The getgroups() system call appeared in 4.2BSD. BSD
January 21, 2011 BSD

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