lib/libc/posix1e/acl_get_flag_np.3

   1 .\"-
   2 .\" Copyright (c) 2008, 2009 Edward Tomasz Napierala
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd October 30, 2014
  28 .Dt ACL_GET_FLAG_NP 3
  29 .Os
  30 .Sh NAME
  31 .Nm acl_get_flag_np
  32 .Nd check if a flag is set in a flagset
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In sys/types.h
  37 .In sys/acl.h
  38 .Ft int
  39 .Fn acl_get_flag_np "acl_flagset_t flagset_d" "acl_flag_t flag"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn acl_get_flag_np
  43 function
  44 is a non-portable function that checks if a NFSv4 ACL flag is set in
  45 a flagset.
  46 .Sh RETURN VALUES
  47 If the flag in
  48 .Fa flag
  49 is set in the flagset
  50 .Fa flagset_d ,
  51 a value of
  52 1
  53 is returned, otherwise a value of
  54 0
  55 is returned.
  56 .Sh ERRORS
  57 If any of the following conditions occur, the
  58 .Fn acl_get_flag_np
  59 function will return a value of
  60 \-1
  61 and set global variable
  62 .Va errno
  63 to the corresponding value:
  64 .Bl -tag -width Er
  65 .It Bq Er EINVAL
  66 Argument
  67 .Fa flag
  68 does not contain a valid ACL flag or argument
  69 .Fa flagset_d
  70 is not a valid ACL flagset.
  71 .El
  72 .Sh SEE ALSO
  73 .Xr acl 3 ,
  74 .Xr acl_add_flag_np 3 ,
  75 .Xr acl_clear_flags_np 3 ,
  76 .Xr acl_delete_flag_np 3 ,
  77 .Xr acl_get_flagset_np 3 ,
  78 .Xr acl_set_flagset_np 3 ,
  79 .Xr posix1e 3
  80 .Sh STANDARDS
  81 POSIX.1e is described in IEEE POSIX.1e draft 17.
  82 .Sh HISTORY
  83 POSIX.1e support was introduced in
  84 .Fx 4.0 .
  85 The
  86 .Fn acl_get_flag_np
  87 function was added in
  88 .Fx 8.0 .
  89 .Sh AUTHORS
  90 The
  91 .Fn acl_get_flag_np
  92 function was written by
  93 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org .