diff options
Diffstat (limited to 'framework/src/audit/docs/auparse_get_node.3')
-rw-r--r-- | framework/src/audit/docs/auparse_get_node.3 | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/framework/src/audit/docs/auparse_get_node.3 b/framework/src/audit/docs/auparse_get_node.3 new file mode 100644 index 00000000..41731406 --- /dev/null +++ b/framework/src/audit/docs/auparse_get_node.3 @@ -0,0 +1,25 @@ +.TH "AUPARSE_GET_NODE" "3" "Sept 2007" "Red Hat" "Linux Audit API" +.SH NAME +auparse_get_node \- get the event's machine node name +.SH "SYNOPSIS" +.B #include <auparse.h> +.sp +const char *auparse_get_node(auparse_state_t *au); + +.SH "DESCRIPTION" + +auparse_get_node gets the machine's node name if it exists in the audit event from the current event's timestamp data structure. Not all records have node names since its an admin configurable option. + +.SH "RETURN VALUE" + +Returns a copy of the node name or NULL if it does not exist or there was an error. The caller must free the string. + +.SH "SEE ALSO" + +.BR auparse_get_timestamp (3), +.BR auparse_get_time (3), +.BR auparse_get_milli (3). +.BR auparse_get_serial (3). + +.SH AUTHOR +Steve Grubb |