lib/libcr/sys/getgroups.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)getgroups.2 8.2 (Berkeley) 4/16/94
  33 .\" $FreeBSD: src/lib/libc/sys/getgroups.2,v 1.6.2.4 2001/12/14 18:34:00 ru Exp $
  34 .\" $DragonFly: src/lib/libcr/sys/Attic/getgroups.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd March 5, 1999
  37 .Dt GETGROUPS 2
  38 .Os
  39 .Sh NAME
  40 .Nm getgroups
  41 .Nd get group access list
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In unistd.h
  47 .Ft int
  48 .Fn getgroups "int gidsetlen" "gid_t *gidset"
  49 .Sh DESCRIPTION
  50 .Fn Getgroups
  51 gets the current group access list of the user process
  52 and stores it in the array
  53 .Fa gidset .
  54 The parameter
  55 .Fa gidsetlen
  56 indicates the number of entries that may be placed in
  57 .Fa gidset .
  58 .Fn Getgroups
  59 returns the actual number of groups returned in
  60 .Fa gidset .
  61 No more than
  62 .Dv NGROUPS_MAX
  63 will ever
  64 be returned.
  65 If
  66 .Fa gidsetlen
  67 is zero,
  68 .Fn getgroups
  69 returns the number of supplementary group IDs associated with
  70 the calling process without modifying the array pointed to by
  71 .Fa gidset .
  72 .Sh RETURN VALUES
  73 A successful call returns the number of groups in the group set.
  74 A value of -1 indicates that an error occurred, and the error
  75 code is stored in the global variable
  76 .Va errno .
  77 .Sh ERRORS
  78 The possible errors for
  79 .Fn getgroups
  80 are:
  81 .Bl -tag -width Er
  82 .It Bq Er EINVAL
  83 The argument
  84 .Fa gidsetlen
  85 is smaller than the number of groups in the group set.
  86 .It Bq Er EFAULT
  87 The argument
  88 .Fa gidset
  89 specifies
  90 an invalid address.
  91 .El
  92 .Sh SEE ALSO
  93 .Xr setgroups 2 ,
  94 .Xr initgroups 3
  95 .Sh HISTORY
  96 The
  97 .Fn getgroups
  98 function call appeared in
  99 .Bx 4.2 .