xref: /freebsd/lib/libc/posix1e/acl_init.3 (revision a7623790fb345e6dc986dfd31df0ace115e6f2e4)
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.\" $FreeBSD$
29.\"
30.Dd January 28, 2000
31.Dt ACL_INIT 3
32.Os
33.Sh NAME
34.Nm acl_init
35.Nd initialize ACL working storage
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/types.h
40.In sys/acl.h
41.Ft acl_t
42.Fn acl_init "int count"
43.Sh DESCRIPTION
44The
45.Fn acl_init
46function allocates and initializes the working storage for an ACL of at
47least
48.Va count
49ACL entries.
50A pointer to the working storage is returned.
51The working
52storage allocated to contain the ACL is freed by a call to
53.Xr acl_free 3 .
54When the area is first allocated, it shall contain an ACL that contains
55no ACL entries.
56.Pp
57This function may cause memory to be allocated.
58The caller should free any
59releasable memory, when the new ACL is no longer required, by calling
60.Xr acl_free 3
61with the
62.Va (void*)acl_t
63as an argument.
64.Sh IMPLEMENTATION NOTES
65.Fx Ns 's
66support for POSIX.1e interfaces and features is still under
67development at this time.
68.Sh RETURN VALUES
69Upon successful completion, this function shall return a pointer to the
70working storage.
71Otherwise, a value of
72.Va (acl_t)NULL
73shall be returned, and
74.Va errno
75shall be set to indicate the error.
76.Sh ERRORS
77If any of the following conditions occur, the
78.Fn acl_init
79function shall return a value of
80.Va (acl_t)NULL
81and set
82.Va errno
83to the corresponding value:
84.Bl -tag -width Er
85.It Bq Er EINVAL
86The value of count is less than zero.
87.It Bq Er ENOMEM
88The
89.Va acl_t
90to be returned requires more memory than is allowed by the hardware or
91system-imposed memory management constraints.
92.El
93.Sh SEE ALSO
94.Xr acl 3 ,
95.Xr acl_free 3 ,
96.Xr posix1e 3
97.Sh STANDARDS
98POSIX.1e is described in IEEE POSIX.1e draft 17.
99Discussion
100of the draft continues on the cross-platform POSIX.1e implementation
101mailing list.
102To join this list, see the
103.Fx
104POSIX.1e implementation
105page for more information.
106.Sh HISTORY
107POSIX.1e support was introduced in
108.Fx 4.0 ,
109and development continues.
110.Sh AUTHORS
111.An Robert N M Watson
112