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