aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/audit/docs/auparse_get_line_number.3
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/audit/docs/auparse_get_line_number.3')
-rw-r--r--framework/src/audit/docs/auparse_get_line_number.327
1 files changed, 27 insertions, 0 deletions
diff --git a/framework/src/audit/docs/auparse_get_line_number.3 b/framework/src/audit/docs/auparse_get_line_number.3
new file mode 100644
index 00000000..bd0c4177
--- /dev/null
+++ b/framework/src/audit/docs/auparse_get_line_number.3
@@ -0,0 +1,27 @@
+.TH "AUPARSE_GET_LINE_NUMBER" "3" "Feb 2007" "Red Hat" "Linux Audit API"
+.SH NAME
+auparse_get_line_number \- get line number where record was found
+.SH "SYNOPSIS"
+.B #include <auparse.h>
+.sp
+unsigned int auparse_get_line_number(auparse_state_t *au);
+
+.SH "DESCRIPTION"
+
+auparse_get_line_number will return the source input line number for
+the current record of the current event. Line numbers start at 1. If
+the source input type is AUSOURCE_FILE_ARRAY the line numbering will
+reset back to 1 each time a new life in the file array is opened.
+
+.SH "RETURN VALUE"
+
+Returns the line number. Line numbers are 1 based, a zero value
+indicates the line number information is unavailable.
+
+.SH "SEE ALSO"
+
+.BR auparse_get_filename (3).
+.BR auparse_next_record (3).
+
+.SH AUTHOR
+John Dennis