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