xref: /freebsd/lib/libc/posix1e/acl_delete_entry.3 (revision cc68614da8232d8baaca0ae0d0dd8f890f06623e)
1.\"-
2.\" Copyright (c) 2001 Chris D. Faulhaber
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 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 June 25, 2009
29.Dt ACL_DELETE_ENTRY 3
30.Os
31.Sh NAME
32.Nm acl_delete_entry ,
33.Nm acl_delete_entry_np
34.Nd delete an ACL entry from an ACL
35.Sh LIBRARY
36.Lb libc
37.Sh SYNOPSIS
38.In sys/types.h
39.In sys/acl.h
40.Ft int
41.Fn acl_delete_entry "acl_t acl" "acl_entry_t entry_d"
42.Ft int
43.Fn acl_delete_entry_np "acl_t acl" "int index"
44.Sh DESCRIPTION
45The
46.Fn acl_delete_entry
47function
48is a POSIX.1e call that removes the ACL entry
49.Fa entry_d
50from ACL
51.Fa acl .
52The
53.Fn acl_delete_entry_np
54function is a non-portable version that removes the ACL entry
55at position
56.Fa index
57from ACL
58.Fa acl .
59Positions are numbered starting from zero, i.e. calling
60.Fn acl_delete_entry_np
61with
62.Fa index
63argument equal to zero will remove the first ACL entry.
64.Sh RETURN VALUES
65.Rv -std acl_delete_entry
66.Sh ERRORS
67The
68.Fn acl_delete_entry
69function fails if:
70.Bl -tag -width Er
71.It Bq Er EINVAL
72Argument
73.Fa acl
74does not point to a valid ACL.
75Argument
76.Fa entry_d
77is not a valid descriptor for an ACL entry in
78.Fa acl .
79Argument
80.Fa index
81is out of bounds.
82.El
83.Sh SEE ALSO
84.Xr acl 3 ,
85.Xr acl_copy_entry 3 ,
86.Xr acl_get_entry 3 ,
87.Xr posix1e 3
88.Sh STANDARDS
89POSIX.1e is described in IEEE POSIX.1e draft 17.
90.Sh HISTORY
91POSIX.1e support was introduced in
92.Fx 4.0 .
93The
94.Fn acl_delete_entry
95function was added in
96.Fx 5.0 .
97.Sh AUTHORS
98The
99.Fn acl_delete_entry
100function was written by
101.An Chris D. Faulhaber Aq Mt jedgar@fxp.org .
102