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