'\" te
.\" Copyright 1989 AT&T.  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
.TH initgroups 3C "22 Mar 2004" "SunOS 5.11" "Standard C Library Functions"
.SH NAME
initgroups \- initialize the supplementary group access list
.SH SYNOPSIS
.LP
.nf
#include <grp.h>
#include <sys/types.h>

\fBint\fR \fBinitgroups\fR(\fBconst char *\fR\fIname\fR, \fBgid_t\fR \fIbasegid\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBinitgroups()\fR function reads the group database to get the group membership for the user specified by \fIname\fR, and initializes the supplementary group access list of the calling process (see \fBgetgrnam\fR(3C) and \fBgetgroups\fR(2)). The \fIbasegid\fR group ID is also included in the supplementary group access list. This is typically the real group ID from the user database.
.sp
.LP
While scanning the group database, if the number of groups, including the \fIbasegid\fR entry, exceeds \fBNGROUPS_MAX\fR, subsequent group entries are ignored.
.SH RETURN VALUES
.sp
.LP
Upon successful completion, 0 is returned. Otherwise, \(mi1 is returned and \fBerrno\fR is set to indicate the error.
.SH ERRORS
.sp
.LP
The \fBinitgroups()\fR function will fail and not change the supplementary group access list if:
.sp
.ne 2
.mk
.na
\fB\fBEPERM\fR\fR
.ad
.RS 9n
.rt  
The {\fBPRIV_PROC_SETID\fR} privilege is not asserted in the effective set of the calling process.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelMT-Safe
.TE

.SH SEE ALSO
.sp
.LP
\fBgetgroups\fR(2), \fBgetgrnam\fR(3C), \fBattributes\fR(5)