posix1e/acl_create_entry.3

   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 THE AUTHOR OR THE VOICES IN HIS HEAD BE
  18 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  19 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  20 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  21 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  22 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  23 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  24 .\" POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/lib/libc/posix1e/acl_create_entry.3,v 1.5 2002/12/18 12:45:09 ru Exp $
  27 .\"
  28 .Dd March 16, 2001
  29 .Dt ACL_CREATE_ENTRY 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_create_entry ,
  33 .Nm acl_create_entry_np
  34 .Nd create a new ACL entry
  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_create_entry "acl_t *acl_p" "acl_entry_t *entry_p"
  42 .Ft int
  43 .Fn acl_create_entry_np "acl_t *acl_p" "acl_entry_t *entry_p" "int entry_index"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn acl_create_entry
  47 function
  48 is a POSIX.1e call that creates a new ACL entry in the ACL
  49 pointed to by
  50 .Fa acl_p .
  51 .Pp
  52 The
  53 .Fn acl_create_entry_np
  54 function is a non-portable extension which allows the caller to specify the
  55 position of the created entry within the ACL.  If
  56 .Fa entry_index
  57 is
  58 .Dv ACL_FIRST_ENTRY
  59 the entry will be created at the head of the ACL.  If
  60 .Fa entry_index
  61 is
  62 .Dv ACL_LAST_ENTRY
  63 the entry will be created at the end of the ACL.  After inserting an ACL entry with an
  64 .Fa entry_index
  65 other than
  66 .Dv ACL_LAST_ENTRY
  67 the behaviour of any acl_entry_t's previously obtained from the ACL
  68 by
  69 .Fn acl_create_entry
  70 or
  71 .Fn acl_get_entry
  72 is undefined.
  73 .Sh RETURN VALUES
  74 .Rv -std acl_create_entry
  75 .Sh ERRORS
  76 The
  77 .Fn acl_create_entry
  78 and
  79 .Fn acl_create_entry_np
  80 functions fail if:
  81 .Bl -tag -width Er
  82 .It Bq Er EINVAL
  83 Argument
  84 .Fa acl_p
  85 does not point to a pointer to a valid ACL.
  86 .It Bq Er ENOMEM
  87 The ACL working storage requires more memory than is
  88 allowed by the hardware or system-imposed memory
  89 management constraints.
  90 .It Bq Er ERANGE
  91 The
  92 .Fa entry_index
  93 argument to
  94 .Fn acl_create_entry_np
  95 is greater than the number of entries in the ACL.
  96 .El
  97 .Sh SEE ALSO
  98 .Xr acl 3 ,
  99 .Xr acl_delete_entry 3 ,
 100 .Xr acl_get_entry 3 ,
 101 .Xr posix1e 3
 102 .Sh STANDARDS
 103 POSIX.1e is described in IEEE POSIX.1e draft 17.
 104 .Sh AUTHORS
 105 .An Michael Smith
 106 .An Chris D Fulhaber