diff options
Diffstat (limited to 'lib/libposix1e/cap_get_flag.3')
| -rw-r--r-- | lib/libposix1e/cap_get_flag.3 | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/lib/libposix1e/cap_get_flag.3 b/lib/libposix1e/cap_get_flag.3 new file mode 100644 index 0000000..1e827c9 --- /dev/null +++ b/lib/libposix1e/cap_get_flag.3 @@ -0,0 +1,94 @@ +.\"- +.\" Copyright (c) 2000 Robert N. M. Watson +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.\" TrustedBSD Project - support for POSIX.1e process capabilities +.\" +.Dd April 1, 2000 +.Dt CAP_GET_FLAG 3 +.Os FreeBSD 5.0 +.Sh NAME +.Nm cap_get_flag +.Nd Get the Value of a Capability Flag +.Sh SYNOPSIS +.Fd #include <sys/types.h> +.Fd #include <sys/capability.h> +.Ft int +.Fn cap_get_flag "cap_t cap_p" "cap_value_t cap" "cap_flag_t flag" "cap_flag_value_t *value_p" +.Sh DESCRIPTION +The function +.Fn cap_get_flag +shall obtain the current value of the capability flag +.Ar flag +of the capability +.Ar cap +from the capability state in working storage identified by +.Ar cap_p +and place it into the location pointed to by +.Ar value_p . +.Sh IMPLEMENTATION NOTES +FreeBSD's support for POSIX.1e interfaces and features is still under +development at this time. +.Sh RETURN VALUES +Upon successful completion, the function shall return a value of zero. +Otherwise, a value of -1 shall be returned and +.Va errno +set to indicate the error. +.Sh ERRORS +If any of the following conditions occur, the +.Fn cap_get_flag +function shall return -1 and set +.Va errno +to the corresponding value: +.Bl -tag -width Er +.It Bq Er EINVAL +At least one of the values of the +.Ar cap_p , +.Ar cap , +.Ar flag +and +.Ar value_p +arguments does not refer to the corresponding entity. +.El +.Sh SEE ALSO +.Xr cap 3 , +.Xr cap_set_flag 3 , +.Xr posix1e 3 +.Sh STANDARDS +POSIX.1e is described in IEEE POSIX.1e draft 17. Discussion +of the draft continues on the cross-platform POSIX.1e implementation +mailing list. To join this list, see the +.Fx +POSIX.1e implementation +page for more information. +.Sh HISTORY +Support for POSIX.1e Capabilities was developed as part of the TrustedBSD +Project. +POSIX.1e Capability support was introduced in +.Fx 5.0 , +and development continues. +.Sh AUTHORS +.An Robert N M Watson |
