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