selinux/libsemanage/man/man3/semanage_query.3

47 lines
1.5 KiB
Groff

.TH semanage_query 3 "15 March 2006" "ivg2@cornell.edu" "Libsemanage API documentation"
.SH "NAME"
semanage_query \- SELinux Management API
.SH "SYNOPSIS"
The following query function is supported for any semanage record.
.br
Replace the function and object name as necessary.
.B extern int QUERY_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 query function will fail if a matching key is not found. Otherwise, the corresponding object is returned.
.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 queried, which 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. The object returned becomes a property of the caller, and must be freed with
.B semanage_OBJECT_free.
.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 semanage object read calls until the next commit.
.SH "SEE ALSO"
.BR semanage_handle_create "(3), " semanage_connect "(3), "