NAME    [Toc]    [Back]

     getgrouplist - calculate group access list

SYNOPSIS    [Toc]    [Back]

     #include <unistd.h>

     int
     getgrouplist(const char *name, gid_t basegid, gid_t *groups,
             int *ngroups);

DESCRIPTION    [Toc]    [Back]

     The getgrouplist() function reads through the group file and
calculates
     the group access list for the user specified in  name.   The
basegid is automatically
  included  in  the  groups list.  Typically this
value is given
     as the group number from the password file.

     The resulting group list is returned in  the  integer  array
pointed to by
     groups.   The  caller specifies the size of the groups array
in the integer
     pointed to by ngroups; the actual number of groups found  is
returned in
     ngroups.

RETURN VALUES    [Toc]    [Back]

     The  getgrouplist()  function  returns -1 if the size of the
group list is
     too small to hold all the user's groups.   Here,  the  group
array will be
     filled with as many groups as will fit.

FILES    [Toc]    [Back]

     /etc/group  group database file

SEE ALSO    [Toc]    [Back]

     setgroups(2), initgroups(3)

HISTORY    [Toc]    [Back]

     The getgrouplist() function first appeared in 4.4BSD.

BUGS    [Toc]    [Back]

     The  getgrouplist() function uses the routines based on getgrent(3).  If
     the invoking program uses any of these routines,  the  group
structure will
     be overwritten in the call to getgrouplist().

OpenBSD      3.6                           June      9,      1993