projects / unix-history / blame
| Commit | Line | Data |
|---|---|---|
| 88b3ccf2 KB |
1 | .\" Copyright (c) 1983 The Regents of the University of California. |
| 2 | .\" All rights reserved. | |
| 87e80ad5 | 3 | .\" |
| 1c15e888 C |
4 | .\" Redistribution and use in source and binary forms are permitted provided |
| 5 | .\" that: (1) source distributions retain this entire copyright notice and | |
| 6 | .\" comment, and (2) distributions including binaries display the following | |
| 7 | .\" acknowledgement: ``This product includes software developed by the | |
| 8 | .\" University of California, Berkeley and its contributors'' in the | |
| 9 | .\" documentation or other materials provided with the distribution and in | |
| 10 | .\" all advertising materials mentioning features or use of this software. | |
| 11 | .\" Neither the name of the University nor the names of its contributors may | |
| 12 | .\" be used to endorse or promote products derived from this software without | |
| 13 | .\" specific prior written permission. | |
| 14 | .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED | |
| 15 | .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF | |
| 16 | .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. | |
| 88b3ccf2 | 17 | .\" |
| 1c15e888 | 18 | .\" @(#)getgroups.2 6.6 (Berkeley) 6/23/90 |
| 87e80ad5 | 19 | .\" |
| 1c15e888 | 20 | .TH GETGROUPS 2 "June 23, 1990" |
| 87e80ad5 KM |
21 | .UC 5 |
| 22 | .SH NAME | |
| 23 | getgroups \- get group access list | |
| 24 | .SH SYNOPSIS | |
| 25 | .nf | |
| 26 | .ft B | |
| 27 | #include <sys/param.h> | |
| 28 | .PP | |
| 29 | .ft B | |
| 66f6f7d0 KM |
30 | ngroups = getgroups(gidsetlen, gidset) |
| 31 | int ngroups, gidsetlen, *gidset; | |
| 87e80ad5 KM |
32 | .fi |
| 33 | .SH DESCRIPTION | |
| 34 | .I Getgroups | |
| 35 | gets the current group access list of the user process | |
| 36 | and stores it in the array | |
| 37 | .IR gidset . | |
| 38 | The parameter | |
| 66f6f7d0 | 39 | .I gidsetlen |
| 214b5721 | 40 | indicates the number of entries that may be placed in |
| 66f6f7d0 KM |
41 | .IR gidset. |
| 42 | .I Getgroups | |
| 43 | returns the actual number of groups returned in | |
| 44 | .IR gidset . | |
| 45 | No more than NGROUPS, as defined in | |
| 87e80ad5 KM |
46 | .RI < sys/param.h >, |
| 47 | will ever | |
| 48 | be returned. | |
| 49 | .SH "RETURN VALUE | |
| 66f6f7d0 | 50 | A successful call returns the number of groups in the group set. |
| 87e80ad5 KM |
51 | A value of \-1 indicates that an error occurred, and the error |
| 52 | code is stored in the global variable \fIerrno\fP\|. | |
| 53 | .SH "ERRORS | |
| 54 | The possible errors for \fIgetgroup\fP are: | |
| 55 | .TP 15 | |
| 66f6f7d0 KM |
56 | [EINVAL] |
| 57 | The argument | |
| 58 | .I gidsetlen | |
| 59 | is smaller than the number of groups in the group set. | |
| 60 | .TP | |
| 87e80ad5 | 61 | [EFAULT] |
| 66f6f7d0 KM |
62 | The argument \fIgidset\fP specifies |
| 63 | an invalid address. | |
| 87e80ad5 | 64 | .SH "SEE ALSO |
| 01c39a64 | 65 | setgroups(2), initgroups(3) |
| 7f398d2d MK |
66 | .SH BUGS |
| 67 | The | |
| 68 | .I gidset | |
| 69 | array should be of type | |
| 70 | .BR gid_t , | |
| 71 | but remains integer for compatibility with earlier systems. |