aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/audit/docs/auparse_get_field_str.3
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/audit/docs/auparse_get_field_str.3')
-rw-r--r--framework/src/audit/docs/auparse_get_field_str.324
1 files changed, 24 insertions, 0 deletions
diff --git a/framework/src/audit/docs/auparse_get_field_str.3 b/framework/src/audit/docs/auparse_get_field_str.3
new file mode 100644
index 00000000..e1ebfced
--- /dev/null
+++ b/framework/src/audit/docs/auparse_get_field_str.3
@@ -0,0 +1,24 @@
+.TH "AUPARSE_GET_FIELD_STR" "3" "Feb 2007" "Red Hat" "Linux Audit API"
+.SH NAME
+auparse_get_field_str \- get current field's value
+.SH "SYNOPSIS"
+.B #include <auparse.h>
+.sp
+const char *auparse_get_field_str(auparse_state_t *au);
+
+.SH "DESCRIPTION"
+
+auparse_get_field_str allows access to the value in the current field of the current record in the current event.
+
+.SH "RETURN VALUE"
+
+Returns NULL if an error occurs; otherwise, a pointer to the field's value.
+
+.SH "SEE ALSO"
+
+.BR auparse_get_field_name (3),
+.BR auparse_interpret_field (3),
+.BR auparse_next_field (3).
+
+.SH AUTHOR
+Steve Grubb