Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / auparse_next_record.3
1 .TH "AUPARSE_NEXT_RECORD" "3" "Feb 2007" "Red Hat" "Linux Audit API"
2 .SH NAME
3 auparse_next_record \- move record cursor
4 .SH "SYNOPSIS"
5 .B #include <auparse.h>
6 .sp
7 int auparse_next_record(auparse_state_t *au);
8
9 .SH "DESCRIPTION"
10 auparse_next_record will move the internal library cursors to point to the next record of the current event. You should not call this function from a feed interface callback function. Doing so will deadlock the code. In that scenario, you should check the number of records in the current event with auparse_get_num_records and only call this if there are more records.
11
12 .SH "RETURN VALUE"
13
14 Returns \-1 if an error occurs, 0 if no more records in current event, or 1 for success.
15
16 .SH "SEE ALSO"
17
18 .BR auparse_next_event (3), auparse_get_num_records (3).
19
20 .SH AUTHOR
21 Steve Grubb