diff options
Diffstat (limited to 'framework/src/audit/docs/auparse_get_type.3')
| -rw-r--r-- | framework/src/audit/docs/auparse_get_type.3 | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/framework/src/audit/docs/auparse_get_type.3 b/framework/src/audit/docs/auparse_get_type.3 new file mode 100644 index 00000000..c278e914 --- /dev/null +++ b/framework/src/audit/docs/auparse_get_type.3 @@ -0,0 +1,23 @@ +.TH "AUPARSE_GET_TYPE" "3" "Jan 2014" "Red Hat" "Linux Audit API" +.SH NAME +auparse_get_type \- get record's type +.SH "SYNOPSIS" +.B #include <auparse.h> +.sp +int auparse_get_type(auparse_state_t *au); +const char *auparse_get_type_name(auparse_state_t *au); + +.SH "DESCRIPTION" + +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. + +.SH "RETURN VALUE" + +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. + +.SH "SEE ALSO" + +.BR auparse_next_record (3). + +.SH AUTHOR +Steve Grubb |