getgroups()

Get the supplementary group IDs of the calling process

Synopsis:

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

int getgroups( int gidsetsize, 
               gid_t grouplist[] );

Library:

libc

Description:

The getgroups() function fills the array grouplist with the supplementary group IDs of the calling process. The gidsetsize argument specifies how many elements are in the supplied array. The values of array entries with indices greater than or equal to the returned value are undefined.

Returns:

The number of supplementary groups IDs; this value is zero if NGROUPS_MAX is zero. A value of -1 indicates an error (errno is set).

Errors:

EINVAL

The gidsetsize argument isn't equal to zero, and is less than the number of supplementary group IDs.

Examples:

/*
 * Print the supplementary group IDs of
 * the calling process.
 */
#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <unistd.h>

int main( void )
  {
    int     gidsize;
    gid_t   *grouplist;
    int     i;

    gidsize = getgroups( 0, NULL );
    grouplist = malloc( gidsize * sizeof( gid_t ) );
    getgroups( gidsize, grouplist );
    for( i = 0; i < gidsize; i++ )
      printf( "%d\n", ( int ) grouplist[i] );
    return EXIT_SUCCESS;
  }

Classification:

POSIX 1003.1

See also:

errno