xref: /freebsd/lib/libc/posix1e/acl_get_flagset_np.3 (revision d11f81afd5a4a71d5f725950b0592ca212084780)
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.\" $FreeBSD$
26.\"
27.Dd October 30, 2014
28.Dt ACL_GET_FLAGSET_NP 3
29.Os
30.Sh NAME
31.Nm acl_get_flagset_np
32.Nd retrieve flagset from an NFSv4 ACL entry
33.Sh LIBRARY
34.Lb libc
35.Sh SYNOPSIS
36.In sys/types.h
37.In sys/acl.h
38.Ft int
39.Fn acl_get_flagset_np "acl_entry_t entry_d" "acl_flagset_t *flagset_p"
40.Sh DESCRIPTION
41The
42.Fn acl_get_flagset_np
43function
44is a non-portable call that returns via
45.Fa flagset_np_p
46a descriptor to the flagset in the NFSv4 ACL entry
47.Fa entry_d .
48Subsequent operations using the returned flagset operate
49on the flagset within the ACL entry.
50.Sh RETURN VALUES
51.Rv -std acl_get_flagset_np
52.Sh ERRORS
53The
54.Fn acl_get_flagset_np
55function fails if:
56.Bl -tag -width Er
57.It Bq Er EINVAL
58Argument
59.Fa entry_d
60is not a valid descriptor for an ACL entry.
61.El
62.Sh SEE ALSO
63.Xr acl 3 ,
64.Xr acl_add_flag_np 3 ,
65.Xr acl_clear_flags_np 3 ,
66.Xr acl_delete_flag_np 3 ,
67.Xr acl_set_flagset_np 3 ,
68.Xr posix1e 3
69.Sh STANDARDS
70POSIX.1e is described in IEEE POSIX.1e draft 17.
71.Sh HISTORY
72POSIX.1e support was introduced in
73.Fx 4.0 .
74The
75.Fn acl_get_flagset_np
76function was added in
77.Fx 8.0 .
78.Sh AUTHORS
79The
80.Fn acl_get_flagset_np
81function was written by
82.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org .
83