xref: /freebsd/lib/libc/posix1e/acl_dup.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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_DUP 3
30.Os
31.Sh NAME
32.Nm acl_dup
33.Nd duplicate an ACL
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_dup "acl_t acl"
41.Sh DESCRIPTION
42The
43.Fn acl_dup
44function returns a pointer to a copy of the ACL pointed to by the argument
45.Va acl .
46.Pp
47This function may cause memory to be allocated.
48The caller should free any
49releasable memory, when the new ACL is no longer required, by calling
50.Xr acl_free 3
51with the
52.Va (void*)acl_t
53as an argument.
54.Pp
55Any existing ACL pointers that refer to the ACL referred to by
56.Va acl
57shall continue to refer to the ACL.
58.Sh IMPLEMENTATION NOTES
59.Fx Ns 's
60support for POSIX.1e interfaces and features is still under
61development at this time.
62.Sh RETURN VALUES
63Upon successful completion, this function shall return a pointer to the
64duplicate ACL.
65Otherwise, 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
80Argument
81.Va acl
82does not point to a valid ACL.
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 acl_get 3 ,
93.Xr posix1e 3
94.Sh STANDARDS
95POSIX.1e is described in IEEE POSIX.1e draft 17.
96Discussion
97of the draft continues on the cross-platform POSIX.1e implementation
98mailing list.
99To join this list, see the
100.Fx
101POSIX.1e implementation
102page for more information.
103.Sh HISTORY
104POSIX.1e support was introduced in
105.Fx 4.0 ,
106and development continues.
107.Sh AUTHORS
108.An Robert N M Watson
109