lib/libc/posix1e/cap_get_flag.3

   1 .\"-
   2 .\" Copyright (c) 2000 Robert N. M. Watson
   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 .\" TrustedBSD Project - support for POSIX.1e process capabilities
  29 .\"
  30 .Dd April 1, 2000
  31 .Dt CAP_GET_FLAG 3
  32 .Os
  33 .Sh NAME
  34 .Nm cap_get_flag
  35 .Nd get the value of a capability flag
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .Fd #include <sys/types.h>
  40 .Fd #include <sys/capability.h>
  41 .Ft int
  42 .Fn cap_get_flag "cap_t cap_p" "cap_value_t cap" "cap_flag_t flag" "cap_flag_value_t *value_p"
  43 .Sh DESCRIPTION
  44 The function
  45 .Fn cap_get_flag
  46 shall obtain the current value of the capability flag
  47 .Ar flag
  48 of the capability
  49 .Ar cap
  50 from the capability state in working storage identified by
  51 .Ar cap_p
  52 and place it into the location pointed to by
  53 .Ar value_p .
  54 .Sh IMPLEMENTATION NOTES
  55 .Fx Ns 's
  56 support for POSIX.1e interfaces and features is still under
  57 development at this time.
  58 .Sh RETURN VALUES
  59 Upon successful completion, the function shall return a value of zero.
  60 Otherwise, a value of -1 shall be returned and
  61 .Va errno
  62 set to indicate the error.
  63 .Sh ERRORS
  64 If any of the following conditions occur, the
  65 .Fn cap_get_flag
  66 function shall return -1 and set
  67 .Va errno
  68 to the corresponding value:
  69 .Bl -tag -width Er
  70 .It Bq Er EINVAL
  71 At least one of the values of the
  72 .Ar cap_p ,
  73 .Ar cap ,
  74 .Ar flag
  75 and
  76 .Ar value_p
  77 arguments does not refer to the corresponding entity.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr cap 3 ,
  81 .Xr cap_set_flag 3 ,
  82 .Xr posix1e 3
  83 .Sh STANDARDS
  84 POSIX.1e is described in IEEE POSIX.1e draft 17.  Discussion
  85 of the draft continues on the cross-platform POSIX.1e implementation
  86 mailing list.  To join this list, see the
  87 .Fx
  88 POSIX.1e implementation
  89 page for more information.
  90 .Sh HISTORY
  91 Support for POSIX.1e Capabilities was developed as part of the TrustedBSD
  92 Project.
  93 POSIX.1e Capability support was introduced in
  94 .Fx 5.0 ,
  95 and development continues.
  96 .Sh AUTHORS
  97 .An Robert N M Watson