lib/libc/posix1e/acl_init.3

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