lib/libc/posix1e/acl_get_flag_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 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 June 25, 2009
  29 .Dt ACL_GET_FLAG_NP 3
  30 .Os
  31 .Sh NAME
  32 .Nm acl_get_flag_np
  33 .Nd check if a flag is set in a flagset
  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_flag_np "acl_flagset_t flagset_d" "acl_flag_t flag"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn acl_get_flag_np
  44 function
  45 is a non-portable function that checks if a flag is set in
  46 a flagset.
  47 .Sh RETURN VALUES
  48 If the flag in
  49 .Fa flag
  50 is set in the flagset
  51 .Fa flagset_d ,
  52 a value of
  53 1
  54 is returned, otherwise a value of
  55 0
  56 is returned.
  57 .Sh ERRORS
  58 If any of the following conditions occur, the
  59 .Fn acl_get_flag_np
  60 function will return a value of
  61 \-1
  62 and set global variable
  63 .Va errno
  64 to the corresponding value:
  65 .Bl -tag -width Er
  66 .It Bq Er EINVAL
  67 Argument
  68 .Fa flag
  69 does not contain a valid ACL flag or argument
  70 .Fa flagset_d
  71 is not a valid ACL flagset.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr acl 3 ,
  75 .Xr acl_add_flag_np 3 ,
  76 .Xr acl_clear_flags_np 3 ,
  77 .Xr acl_delete_flag_np 3 ,
  78 .Xr acl_get_flagset_np 3 ,
  79 .Xr acl_set_flagset_np 3 ,
  80 .Xr posix1e 3
  81 .Sh STANDARDS
  82 POSIX.1e is described in IEEE POSIX.1e draft 17.
  83 .Sh HISTORY
  84 POSIX.1e support was introduced in
  85 .Fx 4.0 .
  86 The
  87 .Fn acl_get_flag_np
  88 function was added in
  89 .Fx 8.0 .
  90 .Sh AUTHORS
  91 The
  92 .Fn acl_get_flag_np
  93 function was written by
  94 .An Edward Tomasz Napierala Aq trasz@FreeBSD.org .