]> git.saurik.com Git - apple/libc.git/blame - posix1e/acl_dup.3
Libc-391.tar.gz
[apple/libc.git] / posix1e / acl_dup.3
CommitLineData
3d9156a7
A
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: src/lib/libc/posix1e/acl_dup.3,v 1.12 2002/12/29 20:52:42 rwatson Exp $
29.\"
30.Dd January 28, 2000
31.Dt ACL_DUP 3
32.Os
33.Sh NAME
34.Nm acl_dup
35.Nd duplicate an ACL
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_dup "acl_t acl"
43.Sh DESCRIPTION
44The
45.Fn acl_dup
46function returns a pointer to a copy of the ACL pointed to by the argument
47.Va acl .
48.Pp
49This function may cause memory to be allocated. The caller should free any
50releasable memory, when the new ACL is no longer required, by calling
51.Xr acl_free 3
52with the
53.Va (void*)acl_t
54as an argument.
55.Pp
56Any existing ACL pointers that refer to the ACL referred to by
57.Va acl
58shall continue to refer to the ACL.
59.Sh RETURN VALUES
60Upon successful completion, this function shall return a pointer to the
61duplicate ACL. Otherwise, a value of
62.Va (acl_t)NULL
63shall be returned, and
64.Va errno
65shall be set to indicate the error.
66.Sh ERRORS
67If any of the following conditions occur, the
68.Fn acl_init
69function shall return a value of
70.Va (acl_t)NULL
71and set
72.Va errno
73to the corresponding value:
74.Bl -tag -width Er
75.It Bq Er EINVAL
76Argument
77.Va acl
78does not point to a valid ACL.
79.It Bq Er ENOMEM
80The
81.Va acl_t
82to be returned requires more memory than is allowed by the hardware or
83system-imposed memory management constraints.
84.El
85.Sh SEE ALSO
86.Xr acl 3 ,
87.Xr acl_free 3 ,
88.Xr acl_get 3 ,
89.Xr posix1e 3
90.Sh STANDARDS
91POSIX.1e is described in IEEE POSIX.1e draft 17.
92.Sh AUTHORS
93.An Michael Smith
94.An Robert N M Watson