xref: /freebsd/lib/libc/posix1e/acl_get_permset.3 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
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 AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd May 8, 2023
27.Dt ACL_GET_PERMSET 3
28.Os
29.Sh NAME
30.Nm acl_get_permset
31.Nd retrieve permission set from an ACL entry
32.Sh LIBRARY
33.Lb libc
34.Sh SYNOPSIS
35.In sys/types.h
36.In sys/acl.h
37.Ft int
38.Fn acl_get_permset "acl_entry_t entry_d" "acl_permset_t *permset_p"
39.Sh DESCRIPTION
40The
41.Fn acl_get_permset
42function
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_get_perm_np 3 ,
67.Xr acl_set_permset 3 ,
68.Xr posix1e 3
69.Sh STANDARDS
70POSIX.1e is described in IEEE POSIX.1e draft 17.
71.Sh HISTORY
72POSIX.1e support was introduced in
73.Fx 4.0 .
74The
75.Fn acl_get_permset
76function was added in
77.Fx 5.0 .
78.Sh AUTHORS
79The
80.Fn acl_get_permset
81function was written by
82.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
83