xref: /freebsd/lib/libc/posix1e/acl_get_flag_np.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1.\"-
2.\" Copyright (c) 2008, 2009 Edward Tomasz Napierala
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd October 30, 2014
26.Dt ACL_GET_FLAG_NP 3
27.Os
28.Sh NAME
29.Nm acl_get_flag_np
30.Nd check if a flag is set in a flagset
31.Sh LIBRARY
32.Lb libc
33.Sh SYNOPSIS
34.In sys/types.h
35.In sys/acl.h
36.Ft int
37.Fn acl_get_flag_np "acl_flagset_t flagset_d" "acl_flag_t flag"
38.Sh DESCRIPTION
39The
40.Fn acl_get_flag_np
41function
42is a non-portable function that checks if a NFSv4 ACL flag is set in
43a flagset.
44.Sh RETURN VALUES
45If the flag in
46.Fa flag
47is set in the flagset
48.Fa flagset_d ,
49a value of
501
51is returned, otherwise a value of
520
53is returned.
54.Sh ERRORS
55If any of the following conditions occur, the
56.Fn acl_get_flag_np
57function will return a value of
58\-1
59and set global variable
60.Va errno
61to the corresponding value:
62.Bl -tag -width Er
63.It Bq Er EINVAL
64Argument
65.Fa flag
66does not contain a valid ACL flag or argument
67.Fa flagset_d
68is not a valid ACL flagset.
69.El
70.Sh SEE ALSO
71.Xr acl 3 ,
72.Xr acl_add_flag_np 3 ,
73.Xr acl_clear_flags_np 3 ,
74.Xr acl_delete_flag_np 3 ,
75.Xr acl_get_flagset_np 3 ,
76.Xr acl_set_flagset_np 3 ,
77.Xr posix1e 3
78.Sh STANDARDS
79POSIX.1e is described in IEEE POSIX.1e draft 17.
80.Sh HISTORY
81POSIX.1e support was introduced in
82.Fx 4.0 .
83The
84.Fn acl_get_flag_np
85function was added in
86.Fx 8.0 .
87.Sh AUTHORS
88The
89.Fn acl_get_flag_np
90function was written by
91.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org .
92