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