man/man3/acl_size.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_SIZE 3
  26 .Os "Linux ACL"
  27 .Sh NAME
  28 .Nm acl_size
  29 .Nd get the size of the external representation of an ACL
  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 ssize_t
  36 .Fn acl_size "acl_t acl"
  37 .Sh DESCRIPTION
  38 The
  39 .Fn acl_size
  40 function return the size, in bytes, of the buffer required to hold the exportable, contiguous, persistent form of the ACL pointed to by the argument
  41 .Va acl ,
  42 when converted by
  43 .Fn acl_copy_ext .
  44 .Pp
  45 Any existing ACL entry descriptors that refer to entries in
  46 .Va acl
  47 continue to refer to the same entries. Any existing ACL pointers that refer
  48 to the ACL referred to by
  49 .Va acl
  50 continue to refer to the ACL. The order of ACL entries within
  51 .Va acl
  52 remains unchanged.
  53 .Sh RETURN VALUE
  54 On success, the
  55 .Fn acl_size
  56 function returns the size in bytes of the contiguous, persistent form of
  57 the ACL. On error, a value of
  58 .Li (ssize_t)-1
  59 is returned and
  60 .Va errno
  61 is set appropriately.
  62 .Sh ERRORS
  63 If any of the following conditions occur, the
  64 .Fn acl_size
  65 function returns a value of
  66 .Li (ssize_t)-1
  67 and sets
  68 .Va errno
  69 to the corresponding value:
  70 .Bl -tag -width Er
  71 .It Bq Er EINVAL
  72 The argument
  73 .Va acl
  74 is not a valid pointer to an ACL.
  75 .El
  76 .Sh STANDARDS
  77 IEEE Std 1003.1e draft 17 (\(lqPOSIX.1e\(rq, abandoned)
  78 .Sh SEE ALSO
  79 .Xr acl_copy_ext 3 ,
  80 .Xr acl 5
  81 .Sh AUTHOR
  82 Derived from the FreeBSD manual pages written by
  83 .An "Robert N M Watson" Aq rwatson@FreeBSD.org ,
  84 and adapted for Linux by
  85 .An "Andreas Gruenbacher" Aq a.gruenbacher@bestbits.at .