resetting manifest requested domain to floor
[platform/upstream/acl.git] / man / man3 / acl_free.3
1 .\" Access Control Lists manual pages
2 .\"
3 .\" (C) 2002 Andreas Gruenbacher, <a.gruenbacher@bestbits.at>
4 .\"
5 .\" This is free documentation; you can redistribute it and/or
6 .\" modify it under the terms of the GNU General Public License as
7 .\" published by the Free Software Foundation; either version 2 of
8 .\" the License, or (at your option) any later version.
9 .\"
10 .\" The GNU General Public License's references to "object code"
11 .\" and "executables" are to be interpreted as the output of any
12 .\" document formatting or typesetting system, including
13 .\" intermediate and printed output.
14 .\"
15 .\" This manual is distributed in the hope that it will be useful,
16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 .\" GNU General Public License for more details.
19 .\"
20 .\" You should have received a copy of the GNU General Public
21 .\" License along with this manual.  If not, see
22 .\" <http://www.gnu.org/licenses/>.
23 .\"
24 .Dd March 23, 2002
25 .Dt ACL_FREE 3
26 .Os "Linux ACL"
27 .Sh NAME
28 .Nm acl_free
29 .Nd release memory allocated to an ACL data object
30 .Sh LIBRARY
31 Linux Access Control Lists library (libacl, \-lacl).
32 .Sh SYNOPSIS
33 .In sys/types.h
34 .In sys/acl.h
35 .Ft int
36 .Fn acl_free "void *obj_p"
37 .Sh DESCRIPTION
38 The
39 .Fn acl_free
40 function frees any releasable memory currently allocated by to the ACL data object identified by
41 .Va obj_p .
42 The argument
43 .Va obj_p
44 may identify an ACL, an ACL entry qualifier, or a pointer to a string
45 allocated by the
46 .Fn acl_to_text
47 function.
48 .\" .Sh IMPLEMENTATION NOTES
49 .\" True64 prints a compile time warning for acl_free(text) if text was
50 .\" produced by acl_to_text(). Bad!
51 .Sh RETURN VALUE
52 .Rv -std acl_free
53 .Sh ERRORS
54 If any of the following conditions occur, the
55 .Fn acl_free
56 function returns the value
57 .Li -1
58 and and sets
59 .Va errno
60 to the corresponding value:
61 .Bl -tag -width Er
62 .It Bq Er EINVAL
63 The value of the argument
64 .Va obj_p
65 is invalid.
66 .El
67 .Sh STANDARDS
68 IEEE Std 1003.1e draft 17 (\(lqPOSIX.1e\(rq, abandoned)
69 .Sh SEE ALSO
70 .Xr acl_copy_int 3 ,
71 .Xr acl_create_entry 3 ,
72 .Xr acl_dup 3 ,
73 .Xr acl_from_text 3 ,
74 .Xr acl_get_fd ,
75 .Xr acl_get_file 3 ,
76 .Xr acl_init 3 ,
77 .Xr acl 5
78 .Sh AUTHOR
79 Derived from the FreeBSD manual pages written by
80 .An "Robert N M Watson" Aq rwatson@FreeBSD.org ,
81 and adapted for Linux by
82 .An "Andreas Gruenbacher" Aq a.gruenbacher@bestbits.at .