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