xref: /freebsd/lib/libc/posix1e/acl_init.3 (revision 4b9d6057)
1.\"-
2.\" Copyright (c) 2000, 2002 Robert N. M. Watson
3.\" All rights reserved.
4.\"
5.\" This software was developed by Robert Watson for the TrustedBSD Project.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.Dd January 28, 2000
29.Dt ACL_INIT 3
30.Os
31.Sh NAME
32.Nm acl_init
33.Nd initialize ACL working storage
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/types.h
38.In sys/acl.h
39.Ft acl_t
40.Fn acl_init "int count"
41.Sh DESCRIPTION
42The
43.Fn acl_init
44function allocates and initializes the working storage for an ACL of at
45least
46.Va count
47ACL entries.
48A pointer to the working storage is returned.
49The working
50storage allocated to contain the ACL is freed by a call to
51.Xr acl_free 3 .
52When the area is first allocated, it shall contain an ACL that contains
53no ACL entries.
54.Pp
55This function may cause memory to be allocated.
56The caller should free any
57releasable memory, when the new ACL is no longer required, by calling
58.Xr acl_free 3
59with the
60.Va (void*)acl_t
61as an argument.
62.Sh IMPLEMENTATION NOTES
63.Fx Ns 's
64support for POSIX.1e interfaces and features is still under
65development at this time.
66.Sh RETURN VALUES
67Upon successful completion, this function shall return a pointer to the
68working storage.
69Otherwise, a value of
70.Va (acl_t)NULL
71shall be returned, and
72.Va errno
73shall be set to indicate the error.
74.Sh ERRORS
75If any of the following conditions occur, the
76.Fn acl_init
77function shall return a value of
78.Va (acl_t)NULL
79and set
80.Va errno
81to the corresponding value:
82.Bl -tag -width Er
83.It Bq Er EINVAL
84The value of count is less than zero.
85.It Bq Er ENOMEM
86The
87.Va acl_t
88to be returned requires more memory than is allowed by the hardware or
89system-imposed memory management constraints.
90.El
91.Sh SEE ALSO
92.Xr acl 3 ,
93.Xr acl_free 3 ,
94.Xr posix1e 3
95.Sh STANDARDS
96POSIX.1e is described in IEEE POSIX.1e draft 17.
97Discussion
98of the draft continues on the cross-platform POSIX.1e implementation
99mailing list.
100To join this list, see the
101.Fx
102POSIX.1e implementation
103page for more information.
104.Sh HISTORY
105POSIX.1e support was introduced in
106.Fx 4.0 ,
107and development continues.
108.Sh AUTHORS
109.An Robert N M Watson
110