aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/audit/docs/ausearch_set_stop.3
blob: 627bb822cd86ef8dddef42dad0952d488b9adc13 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
.TH "AUSEARCH_SET_STOP" "3" "Feb 2007" "Red Hat" "Linux Audit API"
.SH NAME
 ausearch_set_stop \- set the cursor position
.SH "SYNOPSIS"
.B #include <auparse.h>
.sp
int ausearch_set_stop(auparse_state_t *au, austop_t where);

.SH "DESCRIPTION"

ausearch_set_stop determines where the internal cursor will stop when a search condition is met. The possible values are:

.RS
.TP
.I AUSEARCH_STOP_EVENT
This one repositions the cursors to the first field of the first record of the event containing the items searched for.
.TP
.I AUSEARCH_STOP_RECORD
This one repositions the cursors to the first field of the record containing the items searched for.
.TP
.I AUSEARCH_STOP_FIELD
This one simply stops on the current field when the evaluation of the rules becomes true.
.RE

.SH "RETURN VALUE"

Returns \-1 if an error occurs; otherwise, 0 for success.

.SH "SEE ALSO"

.BR ausearch_add_item (3), 
.BR ausearch_add_regex (3), 
.BR ausearch_clear (3), 
.BR ausearch_next_event (3).

.SH AUTHOR
Steve Grubb