xref: /freebsd/lib/libc/posix1e/acl_get_permset.3 (revision 5521ff5a4d1929056e7ffc982fac3341ca54df7c)
1.\"-
2.\" Copyright (c) 2001 Chris D. Faulhaber
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR THE VOICES IN HIS HEAD BE
18.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24.\" POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd March 10, 2001
29.Dt ACL_GET_PERMSET 3
30.Os
31.Sh NAME
32.Nm acl_get_permset
33.Nd retrieve permission set from an ACL entry
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.Fd #include <sys/types.h>
38.Fd #include <sys/acl.h>
39.Ft int
40.Fn acl_get_permset "acl_entry_t entry_d" "acl_permset_t *permset_p"
41.Sh DESCRIPTION
42.Fn acl_get_permset
43is a POSIX.1e call that returns via
44.Fa permset_p
45a descriptor to the permission set in the ACL entry
46.Fa entry_d .
47Subsequent operations using the returned permission set operate
48on the permission set within the ACL entry.
49.Sh RETURN VALUES
50.Rv -std acl_get_permset
51.Sh ERRORS
52The
53.Fn acl_get_permset
54function fails if:
55.Bl -tag -width Er
56.It Bq Er EINVAL
57Argument
58.Fa entry_d
59is not a valid descriptor for an ACL entry.
60.El
61.Sh SEE ALSO
62.Xr acl 3 ,
63.Xr acl_add_perm 3 ,
64.Xr acl_clear_perms 3 ,
65.Xr acl_delete_perm 3 ,
66.Xr acl_set_permset 3 ,
67.Xr posix1e 3
68.Sh STANDARDS
69POSIX.1e is described in IEEE POSIX.1e draft 17.
70.Sh HISTORY
71POSIX.1e support was introduced in
72.Fx 4.0 .
73The
74.Fn acl_get_permset
75function was added in
76.Fx 5.0 .
77.Sh AUTHORS
78The
79.Fn acl_get_permset
80function was written by
81.An Chris D. Faulhaber Aq jedgar@fxp.org .
82