lib/libc/posix1e/acl_get_qualifier.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 AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd March 13, 2001
  29 .Dt ACL_GET_QUALIFIER 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_get_qualifier
  33 .Nd retrieve the qualifier from an ACL entry
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/acl.h
  39 .Ft void *
  40 .Fn acl_get_qualifier "acl_entry_t entry_d"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn acl_get_qualifier
  44 function
  45 is a POSIX.1e call that retrieves the qualifier of the tag for
  46 the ACL entry indicated by the argument
  47 .Fa entry_d
  48 into working storage and returns a pointer to that storage.
  49 .Pp
  50 If the value of the tag type in the ACL entry referred to by
  51 .Fa entry_d
  52 is
  53 .Dv ACL_USER ,
  54 then the value returned by
  55 .Fn acl_get_qualifier
  56 will be a pointer to type
  57 .Vt uid_t .
  58 .Pp
  59 If the value of the tag type in
  60 the ACL entry referred to by
  61 .Fa entry_d
  62 is
  63 .Dv ACL_GROUP ,
  64 then the value returned by
  65 .Fn acl_get_qualifier
  66 will be a pointer to type
  67 .Vt gid_t .
  68 .Pp
  69 If the value of the tag type in the ACL entry referred to by
  70 .Fa entry_d
  71 is
  72 .Dv ACL_UNDEFINED_TAG , ACL_USER_OBJ , ACL_GROUP_OBJ ,
  73 .Dv ACL_OTHER , ACL_MASK ,
  74 or an implementation-defined value for which a qualifier
  75 is not supported, then
  76 .Fn acl_get_qualifier
  77 will return a value of
  78 .Vt ( void * ) Ns Dv NULL
  79 and the function will fail.
  80 .Pp
  81 This function may cause memory to be allocated.
  82 The caller should
  83 free any releasable memory, when the new qualifier is no longer
  84 required, by calling
  85 .Fn acl_free
  86 with
  87 .Vt void *
  88 as the argument.
  89 .Sh RETURN VALUES
  90 The
  91 .Fn acl_get_qualifier
  92 function returns a pointer to the allocated storage if successful;
  93 otherwise a
  94 .Dv NULL
  95 pointer is returned and the global variable
  96 .Va errno
  97 is set to indicate the error.
  98 .Sh ERRORS
  99 The
 100 .Fn acl_get_qualifier
 101 fails if:
 102 .Bl -tag -width Er
 103 .It Bq Er EINVAL
 104 Argument
 105 .Fa entry_d
 106 does not point to a valid descriptor for an ACL entry.
 107 The
 108 value of the tag type in the ACL entry referenced by argument
 109 .Fa entry_d
 110 is not
 111 .Dv ACL_USER
 112 or
 113 .Dv ACL_GROUP .
 114 .It Bq Er ENOMEM
 115 The value to be returned requires more memory than is allowed
 116 by the hardware or system-imposed memory management constraints.
 117 .El
 118 .Sh SEE ALSO
 119 .Xr acl 3 ,
 120 .Xr acl_create_entry 3 ,
 121 .Xr acl_free 3 ,
 122 .Xr acl_get_entry 3 ,
 123 .Xr acl_get_tag_type 3 ,
 124 .Xr acl_set_qualifier 3 ,
 125 .Xr acl_set_tag_type 3 ,
 126 .Xr posix1e 3
 127 .Sh STANDARDS
 128 POSIX.1e is described in IEEE POSIX.1e draft 17.
 129 .Sh HISTORY
 130 POSIX.1e support was introduced in
 131 .Fx 4.0 .
 132 The
 133 .Fn acl_get_qualifier
 134 function was added in
 135 .Fx 5.0 .
 136 .Sh AUTHORS
 137 The
 138 .Fn acl_get_qualifier
 139 function was written by
 140 .An Chris D. Faulhaber Aq jedgar@fxp.org .