Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / auparse_get_type.3
1 .TH "AUPARSE_GET_TYPE" "3" "Jan 2014" "Red Hat" "Linux Audit API"
2 .SH NAME
3 auparse_get_type \- get record's type
4 .SH "SYNOPSIS"
5 .B #include <auparse.h>
6 .sp
7 int auparse_get_type(auparse_state_t *au);
8 const char *auparse_get_type_name(auparse_state_t *au);
9
10 .SH "DESCRIPTION"
11
12 auparse_get_type will return the integer value for the current record of the current event. The auparse_get_type_name function will return the text representation of the name of the current record type.
13
14 .SH "RETURN VALUE"
15
16 auparse_get_type returns 0 if an error occurs; otherwise, the record's type. The auparse_get_type_name function returns NULL on error; otherwise a pointer to a string.
17
18 .SH "SEE ALSO"
19
20 .BR auparse_next_record (3).
21
22 .SH AUTHOR
23 Steve Grubb