aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/audit/docs/auparse_get_type.3
diff options
context:
space:
mode:
authorAshlee Young <ashlee@wildernessvoice.com>2015-11-29 08:22:13 -0800
committerAshlee Young <ashlee@wildernessvoice.com>2015-11-29 08:22:13 -0800
commitdf5afa4fcd9725380f94ca6476248d4cc24f889a (patch)
tree65456f62397305febf7f40778c5a413a35d094ef /framework/src/audit/docs/auparse_get_type.3
parent76f6bf922552c00546e6e85ca471eab28f56986c (diff)
v2.4.4 audit sources
Change-Id: I9315a7408817db51edf084fb4d27fbb492785084 Signed-off-by: Ashlee Young <ashlee@wildernessvoice.com>
Diffstat (limited to 'framework/src/audit/docs/auparse_get_type.3')
-rw-r--r--framework/src/audit/docs/auparse_get_type.323
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