Imported Upstream version 2.4.3
[platform/upstream/audit.git] / docs / auparse_get_timestamp.3
1 .TH "AUPARSE_GET_TIMESTAMP" "3" "Sept 2007" "Red Hat" "Linux Audit API"
2 .SH NAME
3 auparse_get_timestamp \- access timestamp of the event
4 .SH "SYNOPSIS"
5 .B #include <auparse.h>
6 .sp
7 const au_event_t *auparse_get_timestamp(auparse_state_t *au);
8
9 .SH "DESCRIPTION"
10
11 auparse_get_timestamp provides an accessor function for the event's timestamp data structure. The data structure is as follows:
12
13 .nf
14 typedef struct
15 {
16         time_t sec;             // Event seconds
17         unsigned int milli;     // millisecond of the timestamp
18         unsigned long serial;   // Serial number of the event
19         const char *host;       // Machine's node name
20 } au_event_t;
21 .fi
22
23 .SH "RETURN VALUE"
24
25 Returns NULL if an error occurs; otherwise, a valid pointer to the data.
26
27 .SH "SEE ALSO"
28
29 .BR auparse_get_time (3), 
30 .BR auparse_get_milli (3), 
31 .BR auparse_get_serial (3),
32 .BR auparse_get_node (3),
33 .BR auparse_timestamp_compare (3).
34
35 .SH AUTHOR
36 Steve Grubb