resetting manifest requested domain to floor
[platform/upstream/acl.git] / man / man3 / acl_get_permset.3
1 .\" Access Control Lists manual pages
2 .\"
3 .\" (C) 2002 Andreas Gruenbacher, <a.gruenbacher@bestbits.at>
4 .\"
5 .\" This is free documentation; you can redistribute it and/or
6 .\" modify it under the terms of the GNU General Public License as
7 .\" published by the Free Software Foundation; either version 2 of
8 .\" the License, or (at your option) any later version.
9 .\"
10 .\" The GNU General Public License's references to "object code"
11 .\" and "executables" are to be interpreted as the output of any
12 .\" document formatting or typesetting system, including
13 .\" intermediate and printed output.
14 .\"
15 .\" This manual is distributed in the hope that it will be useful,
16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 .\" GNU General Public License for more details.
19 .\"
20 .\" You should have received a copy of the GNU General Public
21 .\" License along with this manual.  If not, see
22 .\" <http://www.gnu.org/licenses/>.
23 .\"
24 .Dd March 23, 2002
25 .Dt ACL_GET_PERMSET 3
26 .Os "Linux ACL"
27 .Sh NAME
28 .Nm acl_get_permset
29 .Nd retrieve the permission set from an ACL entry
30 .Sh LIBRARY
31 Linux Access Control Lists library (libacl, \-lacl).
32 .Sh SYNOPSIS
33 .In sys/types.h
34 .In sys/acl.h
35 .Ft int
36 .Fn acl_get_permset "acl_entry_t entry_d" "acl_permset_t *permset_p"
37 .Sh DESCRIPTION
38 The
39 .Fn acl_get_permset
40 function returns in
41 .Va permset_p
42 a descriptor to the permission set in the ACL entry indicated by
43 .Va entry_d .
44 Subsequent operations using the returned permission set descriptor operate on the permission set within the ACL entry.
45 .Pp
46 Any ACL entry descriptors that refer to the entry referred to by
47 .Va entry_d
48 shall continue to refer to those entries.
49 .Sh RETURN VALUE
50 .Rv -std acl_get_permset
51 .Sh ERRORS
52 If any of the following conditions occur, the
53 .Fn acl_get_permset
54 function returns
55 .Li -1
56 and sets
57 .Va errno
58 to the corresponding value:
59 .Bl -tag -width Er
60 .It Bq Er EINVAL
61 The argument
62 .Va entry_d
63 is not a valid descriptor for an ACL entry.
64 .El
65 .Sh STANDARDS
66 IEEE Std 1003.1e draft 17 (\(lqPOSIX.1e\(rq, abandoned)
67 .Sh SEE ALSO
68 .Xr acl_add_perm 3 ,
69 .Xr acl_clear_perms 3 ,
70 .Xr acl_delete_perm 3 ,
71 .Xr acl_get_perm 3 ,
72 .Xr acl_get_qualifier 3 ,
73 .Xr acl_get_tag_type 3 ,
74 .Xr acl_set_permset 3 ,
75 .Xr acl_set_qualifier 3 ,
76 .Xr acl_set_tag_type 3 ,
77 .Xr acl 5
78 .Sh AUTHOR
79 Derived from the FreeBSD manual pages written by
80 .An "Robert N M Watson" Aq rwatson@FreeBSD.org ,
81 and adapted for Linux by
82 .An "Andreas Gruenbacher" Aq a.gruenbacher@bestbits.at .