lib/libc/posix1e/acl_get_flagset_np.3

   1 .\"-
   2 .\" Copyright (c) 2008, 2009 Edward Tomasz Napierala
   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$
  27 .\"
  28 .Dd June 25, 2009
  29 .Dt ACL_GET_FLAGSET_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_get_flagset_np
  33 .Nd retrieve flagset from an NFSv4 ACL entry
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In sys/acl.h
  39 .Ft int
  40 .Fn acl_get_flagset_np "acl_entry_t entry_d" "acl_flagset_t *flagset_p"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn acl_get_flagset_np
  44 function
  45 is a non-portable call that returns via
  46 .Fa flagset_np_p
  47 a descriptor to the flagset in the ACL entry
  48 .Fa entry_d .
  49 Subsequent operations using the returned flagset operate
  50 on the flagset within the ACL entry.
  51 .Sh RETURN VALUES
  52 .Rv -std acl_get_flagset_np
  53 .Sh ERRORS
  54 The
  55 .Fn acl_get_flagset_np
  56 function fails if:
  57 .Bl -tag -width Er
  58 .It Bq Er EINVAL
  59 Argument
  60 .Fa entry_d
  61 is not a valid descriptor for an ACL entry.
  62 .El
  63 .Sh SEE ALSO
  64 .Xr acl 3 ,
  65 .Xr acl_add_flag_np 3 ,
  66 .Xr acl_clear_flags_np 3 ,
  67 .Xr acl_delete_flag_np 3 ,
  68 .Xr acl_set_flagset_np 3 ,
  69 .Xr posix1e 3
  70 .Sh STANDARDS
  71 POSIX.1e is described in IEEE POSIX.1e draft 17.
  72 .Sh HISTORY
  73 POSIX.1e support was introduced in
  74 .Fx 4.0 .
  75 The
  76 .Fn acl_get_flagset_np
  77 function was added in
  78 .Fx 8.0 .
  79 .Sh AUTHORS
  80 The
  81 .Fn acl_get_flagset_np
  82 function was written by
  83 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org .