xref: /freebsd/lib/libc/posix1e/acl_get_perm_np.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 April 10, 2001
29.Dt ACL_GET_PERM_NP 3
30.Os
31.Sh NAME
32.Nm acl_get_perm_np
33.Nd "check if a permission is set in a permission set"
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_perm_np "acl_permset_t permset_d" "acl_perm_t perm"
41.Sh DESCRIPTION
42The
43.Fn acl_get_perm_np
44function
45is a non-portable function that checks if a permission is set in
46a permission set.
47.Sh RETURN VALUES
48If the permission in
49.Fa perm
50is set in the permission set
51.Fa permset_d ,
52a value of
531
54is returned, otherwise a value of
550
56is returned.
57.Sh ERRORS
58If any of the following conditions occur, the
59.Fn acl_get_perm_np
60function will return a value of
61\-1
62and set global variable
63.Va errno
64to the corresponding value:
65.Bl -tag -width Er
66.It Bq Er EINVAL
67Argument
68.Fa perm
69does not contain a valid ACL permission or argument
70.Fa permset_d
71is not a valid ACL permset.
72.El
73.Sh SEE ALSO
74.Xr acl 3 ,
75.Xr acl_add_perm 3 ,
76.Xr acl_clear_perms 3 ,
77.Xr acl_delete_perm 3 ,
78.Xr acl_get_permset 3 ,
79.Xr acl_set_permset 3 ,
80.Xr posix1e 3
81.Sh STANDARDS
82POSIX.1e is described in IEEE POSIX.1e draft 17.
83.Sh HISTORY
84POSIX.1e support was introduced in
85.Fx 4.0 .
86The
87.Fn acl_get_perm_np
88function was added in
89.Fx 5.0 .
90.Sh AUTHORS
91The
92.Fn acl_get_perm_np
93function was written by
94.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
95