xref: /freebsd/lib/libc/posix1e/acl_get_brand_np.3 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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 June 25, 2009
26.Dt ACL_GET_BRAND_NP 3
27.Os
28.Sh NAME
29.Nm acl_get_brand_np
30.Nd retrieve the ACL brand from an 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_brand_np "acl_t acl" "int *brand_p"
38.Sh DESCRIPTION
39The
40.Fn acl_get_brand_np
41function
42is a non-portable call that returns the ACL brand for the ACL
43.Fa acl .
44Upon successful completion, the location referred to by the argument
45.Fa brand_p
46will be set to the ACL brand of the ACL
47.Fa acl .
48.Pp
49Branding is an internal mechanism intended to prevent mixing POSIX.1e
50and NFSv4 entries by mistake.
51It's also used by the libc to determine how to print out the ACL.
52The first call to function that is specific for one particular brand - POSIX.1e
53or NFSv4 - "brands" the ACL.
54After that, calling function specific to another brand will result in error.
55.Sh RETURN VALUES
56.Rv -std acl_get_brand_np
57.Sh ERRORS
58The
59.Fn acl_get_brand_np
60function fails if:
61.Bl -tag -width Er
62.It Bq Er EINVAL
63Argument
64.Fa acl
65does not point to a valid ACL.
66.El
67.Sh SEE ALSO
68.Xr acl 3 ,
69.Xr posix1e 3
70.Sh STANDARDS
71POSIX.1e is described in IEEE POSIX.1e draft 17.
72.Sh HISTORY
73POSIX.1e support was introduced in
74.Fx 4.0 .
75The
76.Fn acl_get_brand_np
77function was added in
78.Fx 8.0 .
79.Sh AUTHORS
80The
81.Fn acl_get_brand_np
82function was written by
83.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org .
84