xref: /freebsd/lib/libc/posix1e/acl_get_permset.3 (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
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.\" $FreeBSD$
27.\"
28.Dd May 8, 2023
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.In sys/types.h
38.In sys/acl.h
39.Ft int
40.Fn acl_get_permset "acl_entry_t entry_d" "acl_permset_t *permset_p"
41.Sh DESCRIPTION
42The
43.Fn acl_get_permset
44function
45is a POSIX.1e call that returns via
46.Fa permset_p
47a descriptor to the permission set in the ACL entry
48.Fa entry_d .
49Subsequent operations using the returned permission set operate
50on the permission set within the ACL entry.
51.Sh RETURN VALUES
52.Rv -std acl_get_permset
53.Sh ERRORS
54The
55.Fn acl_get_permset
56function fails if:
57.Bl -tag -width Er
58.It Bq Er EINVAL
59Argument
60.Fa entry_d
61is not a valid descriptor for an ACL entry.
62.El
63.Sh SEE ALSO
64.Xr acl 3 ,
65.Xr acl_add_perm 3 ,
66.Xr acl_clear_perms 3 ,
67.Xr acl_delete_perm 3 ,
68.Xr acl_get_perm_np 3 ,
69.Xr acl_set_permset 3 ,
70.Xr posix1e 3
71.Sh STANDARDS
72POSIX.1e is described in IEEE POSIX.1e draft 17.
73.Sh HISTORY
74POSIX.1e support was introduced in
75.Fx 4.0 .
76The
77.Fn acl_get_permset
78function was added in
79.Fx 5.0 .
80.Sh AUTHORS
81The
82.Fn acl_get_permset
83function was written by
84.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
85