bsd/man/man2/getgroups.2

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