diff options
Diffstat (limited to 'framework/src/audit/docs/auparse_next_record.3')
| -rw-r--r-- | framework/src/audit/docs/auparse_next_record.3 | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/framework/src/audit/docs/auparse_next_record.3 b/framework/src/audit/docs/auparse_next_record.3 new file mode 100644 index 00000000..a26a9573 --- /dev/null +++ b/framework/src/audit/docs/auparse_next_record.3 @@ -0,0 +1,21 @@ +.TH "AUPARSE_NEXT_RECORD" "3" "Feb 2007" "Red Hat" "Linux Audit API" +.SH NAME +auparse_next_record \- move record cursor +.SH "SYNOPSIS" +.B #include <auparse.h> +.sp +int auparse_next_record(auparse_state_t *au); + +.SH "DESCRIPTION" +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. + +.SH "RETURN VALUE" + +Returns \-1 if an error occurs, 0 if no more records in current event, or 1 for success. + +.SH "SEE ALSO" + +.BR auparse_next_event (3), auparse_get_num_records (3). + +.SH AUTHOR +Steve Grubb |