GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
GETGROUPS(2) FreeBSD System Calls Manual GETGROUPS(2)

getgroups
get group access list

Standard C Library (libc, -lc)

#include <unistd.h>

int
getgroups(int gidsetlen, gid_t *gidset);

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

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.

The possible errors for getgroups() are:
[]
The argument gidsetlen is smaller than the number of groups in the group set.
[]
The argument gidset specifies an invalid address.

setgroups(2), initgroups(3), sysconf(3)

The getgroups() system call conforms to IEEE Std 1003.1-2008 (“POSIX.1”).

The getgroups() system call appeared in 4.2BSD.
January 21, 2011 FreeBSD 13.1-RELEASE

Search for    or go to Top of page |  Section 2 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.