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