xref: /illumos-gate/usr/src/man/man3c/initgroups.3c (revision 71815ce76261aa773c97600750fdce92334d1990)
te
Copyright 1989 AT&T. Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
INITGROUPS 3C "Mar 22, 2004"
NAME
initgroups - initialize the supplementary group access list
SYNOPSIS

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

int initgroups(const char *name, gid_t basegid);
DESCRIPTION

The initgroups() function reads the group database to get the group membership for the user specified by name, and initializes the supplementary group access list of the calling process (see getgrnam(3C) and getgroups(2)). The basegid group ID is also included in the supplementary group access list. This is typically the real group ID from the user database.

While scanning the group database, if the number of groups, including the basegid entry, exceeds NGROUPS_MAX, subsequent group entries are ignored.

RETURN VALUES

Upon successful completion, 0 is returned. Otherwise, -1 is returned and errno is set to indicate the error.

ERRORS

The initgroups() function will fail and not change the supplementary group access list if: EPERM

The {PRIV_PROC_SETID} privilege is not asserted in the effective set of the calling process.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level MT-Safe
SEE ALSO

getgroups (2), getgrnam (3C), attributes (7)