xref: /freebsd/lib/libc/posix1e/acl_init.3 (revision e4c3e988a5d9f74086eab6223bd6c3db6ff87a10)
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.  A pointer to the working storage is returned.  The 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.  The caller should free any
56releasable memory, when the new ACL is no longer required, by calling
57.Xr acl_free 3
58with the
59.Va (void*)acl_t
60as an argument.
61.Sh IMPLEMENTATION NOTES
62.Fx Ns 's
63support for POSIX.1e interfaces and features is still under
64development at this time.
65.Sh RETURN VALUES
66Upon successful completion, this function shall return a pointer to the
67working storage.  Otherwise, a value of
68.Va (acl_t)NULL
69shall be returned, and
70.Va errno
71shall be set to indicate the error.
72.Sh ERRORS
73If any of the following conditions occur, the
74.Fn acl_init
75function shall return a value of
76.Va (acl_t)NULL
77and set
78.Va errno
79to the corresponding value:
80.Bl -tag -width Er
81.It Bq Er EINVAL
82The value of count is less than zero.
83.It Bq Er ENOMEM
84The
85.Va acl_t
86to be returned requires more memory than is allowed by the hardware or
87system-imposed memory management constraints.
88.El
89.Sh SEE ALSO
90.Xr acl 3 ,
91.Xr acl_free 3 ,
92.Xr posix1e 3
93.Sh STANDARDS
94POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
95of the draft continues on the cross-platform POSIX.1e implementation
96mailing list.  To join this list, see the
97.Fx
98POSIX.1e implementation
99page for more information.
100.Sh HISTORY
101POSIX.1e support was introduced in
102.Fx 4.0 ,
103and development continues.
104.Sh AUTHORS
105.An Robert N M Watson
106