Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
GETGROUPS(2)		    BSD	System Calls 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 user	process	and
     stores it in the array gidset.  The parameter gidsetlen indicates the
     number of entries that may	be placed in gidset.  Getgroups() returns the
     actual number of groups returned in gidset, which is limited to the value
     returned by sysconf(_SC_NGROUPS_MAX).  If gidsetlen is zero, getgroups()
     returns the number	of supplementary group IDs associated with the calling
     process without modifying the array pointed to by gidset.

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)

HISTORY
     The getgroups() function call appeared in 4.2BSD.

4.2 Berkeley Distribution	April 16, 1994	     4.2 Berkeley Distribution

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=getgroups&sektion=2&manpath=FreeBSD+3.2-RELEASE>

home | help