selinux/libsemanage/man/man3/semanage_exists.3
Manoj Srivastava a6700ba05f libsemanage: Fix the format of the NAME lines
Each manual page should start with a "NAME" section, which lists the
name and a brief description of the page separated by "\-". These
sections are parsed by "mandb" and stored in a database for the use of
"apropos" and "whatis", so they must be in a certain format. These
manual pages apparently use the wrong format and cannot be parsed by
"mandb". This commit fixes that.

Signed-off-by: Manoj Srivastava <srivasta@debian.org>
Signed-off-by: Joshua Brindle <method@manicmethod.com>
2009-11-27 12:51:57 -05:00

46 lines
1.4 KiB
Groff

.TH semanage_exists 3 "16 March 2006" "ivg2@cornell.edu" "Libsemanage API documentation"
.SH "NAME"
semanage_exists \- SELinux Management API
.SH "SYNOPSIS"
The following exists function is supported for any semanage record.
.br
Replace the function and object name as necessary.
.B extern int EXISTS_FUNCTION (
.br
.BI " semanage_handle_t *" handle ","
.br
.BI " const semanage_OBJECT_key_t *" key ","
.br
.BI " semanage_OBJECT_t **" response ");"
.SH "DESCRIPTION"
.TP
.B Behavior:
The exists function will return 0 if a matching key is not found, and 1 otherwise.
.TP
.B Parameters:
The
.I handle
is used to track persistent state across semanage calls, and for error reporting. The
.I key
identifies the object being checked. The result of the test will be stored in the address pointed by
.I response
The key is a property of the caller, and will not be stored or modified internally.
.TP
.B Requirements:
This function requires an semanage connection to be established (see
.BR semanage_connect "(3)"
)
.SH "RETURN VALUE"
In case of failure, -1 is returned, and the semanage error callback is invoked, describing the error.
Otherwise a non-negative integer is returned (a commit number). The same number will be returned by all other read calls to the semanage database until the next commit.
.SH "SEE ALSO"
.BR semanage_handle_create "(3), " semanage_connect "(3), "