docs/ausearch_set_stop.3

   1 .TH "AUSEARCH_SET_STOP" "3" "Feb 2007" "Red Hat" "Linux Audit API"
   2 .SH NAME
   3  ausearch_set_stop \- set the cursor position
   4 .SH "SYNOPSIS"
   5 .B #include <auparse.h>
   6 .sp
   7 int ausearch_set_stop(auparse_state_t *au, austop_t where);
   8
   9 .SH "DESCRIPTION"
  10
  11 ausearch_set_stop determines where the internal cursor will stop when a search condition is met. The possible values are:
  12
  13 .RS
  14 .TP
  15 .I AUSEARCH_STOP_EVENT
  16 This one repositions the cursors to the first field of the first record of the event containing the items searched for.
  17 .TP
  18 .I AUSEARCH_STOP_RECORD
  19 This one repositions the cursors to the first field of the record containing the items searched for.
  20 .TP
  21 .I AUSEARCH_STOP_FIELD
  22 This one simply stops on the current field when the evaluation of the rules becomes true.
  23 .RE
  24
  25 .SH "RETURN VALUE"
  26
  27 Returns \-1 if an error occurs; otherwise, 0 for success.
  28
  29 .SH "SEE ALSO"
  30
  31 .BR ausearch_add_item (3),
  32 .BR ausearch_add_regex (3),
  33 .BR ausearch_clear (3),
  34 .BR ausearch_next_event (3).
  35
  36 .SH AUTHOR
  37 Steve Grubb