man/man3/acl_copy_int.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_COPY_INT 3
  26 .Os "Linux ACL"
  27 .Sh NAME
  28 .Nm acl_copy_int
  29 .Nd copy an ACL from external to internal representation
  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 acl_t
  36 .Fn acl_copy_int "const void *buf_p"
  37 .Sh DESCRIPTION
  38 The
  39 .Fn acl_copy_int
  40 function copies an exportable, contiguous, persistent form of an ACL, pointed to by
  41 .Va buf_p ,
  42 to the internal representation.
  43 .Pp
  44 This function may cause memory to be allocated.  The caller should free any
  45 releasable memory, when the new ACL is no longer required, by calling
  46 .Xr acl_free 3
  47 with the
  48 .Va (void*)acl_t
  49 returned by
  50 .Fn acl_copy_int
  51 as an argument.
  52 .Sh RETURN VALUE
  53 Upon success,
  54 the
  55 .Fn acl_copy_int
  56 function returns a pointer that references the ACL in working storage.
  57 On error, a value of
  58 .Li (acl_t)NULL
  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_copy_int
  65 function returns a value of
  66 .Li (acl_t)NULL
  67 and sets
  68 .Va errno
  69 to the corresponding value:
  70 .Bl -tag -width Er
  71 .It Bq Er EINVAL
  72 The buffer pointed to by the argument
  73 .Va buf_p
  74 does not contain a valid external form ACL.
  75 .It Bq Er ENOMEM
  76 The ACL working storage requires more memory than is allowed by the hardware or system-imposed memory management constraints.
  77 .El
  78 .Sh STANDARDS
  79 IEEE Std 1003.1e draft 17 (\(lqPOSIX.1e\(rq, abandoned)
  80 .Sh SEE ALSO
  81 .Xr acl_copy_ext 3 ,
  82 .Xr acl_get_entry 3 ,
  83 .Xr acl_free 3 ,
  84 .Xr acl 5
  85 .Sh AUTHOR
  86 Derived from the FreeBSD manual pages written by
  87 .An "Robert N M Watson" Aq rwatson@FreeBSD.org ,
  88 and adapted for Linux by
  89 .An "Andreas Gruenbacher" Aq a.gruenbacher@bestbits.at .