Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / auparse_first_record.3
1 .TH "AUPARSE_FIRST_RECORD" "3" "Sep 2014" "Red Hat" "Linux Audit API"
2 .SH NAME
3 auparse_first_record \- reposition record cursor
4 .SH "SYNOPSIS"
5 .B #include <auparse.h>
6 .sp
7 int auparse_first_record(auparse_state_t *au);
8
9 .SH "DESCRIPTION"
10 auparse_first_record repositions the internal cursors of the parsing library to point to the first field of the first record in the current event.
11
12 .SH "RETURN VALUE"
13
14 Returns \-1 if an error occurs, 0 if there is no event data, or 1 for success.
15
16 .SH "SEE ALSO"
17
18 .BR auparse_next_event (3),
19 .BR auparse_next_record (3).
20
21 .SH AUTHOR
22 Steve Grubb