Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / auparse_get_field_type.3
1 .TH "AUPARSE_GET_FIELD_TYPE" "3" "Sept 2008" "Red Hat" "Linux Audit API"
2 .SH NAME
3 auparse_get_field_type \- get current field's data type 
4 .SH "SYNOPSIS"
5 .B #include <auparse.h>
6 .sp
7 int auparse_get_field_type(auparse_state_t *au);
8
9 .SH "DESCRIPTION"
10
11 auparse_get_field_type returns a value from the auparse_type_t enum that describes the kind of data in the current field of the current record in the current event.
12
13 .SH "RETURN VALUE"
14
15 Returns AUPARSE_TYPE_UNCLASSIFIED if the field's data type has no known description or is an integer. Otherwise it returns another enum. Fields with the type AUPARSE_TYPE_ESCAPED must be interpretted to access their value since those field's raw value is encoded.
16
17 .SH "SEE ALSO"
18
19 .BR auparse_get_field_name (3).
20
21 .SH AUTHOR
22 Steve Grubb