aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/audit/docs/auparse_goto_record_num.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_goto_record_num.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_goto_record_num.3')
-rw-r--r--framework/src/audit/docs/auparse_goto_record_num.321
1 files changed, 21 insertions, 0 deletions
diff --git a/framework/src/audit/docs/auparse_goto_record_num.3 b/framework/src/audit/docs/auparse_goto_record_num.3
new file mode 100644
index 00000000..0688d969
--- /dev/null
+++ b/framework/src/audit/docs/auparse_goto_record_num.3
@@ -0,0 +1,21 @@
+.TH "AUPARSE_GOTO_RECORD_NUM" "3" "May 2008" "Red Hat" "Linux Audit API"
+.SH NAME
+auparse_goto_record_num \- move record cursor to specific record
+.SH "SYNOPSIS"
+.B #include <auparse.h>
+.sp
+int auparse_goto_record_num(auparse_state_t *au, unsigned int num);
+
+.SH "DESCRIPTION"
+auparse_goto_record_num will move the internal library cursors to point to a specific physical record number. Records within the same event are numbered starting from 0. This is generally not needed but there are some cases where one may want precise control over the exact record being looked at.
+
+.SH "RETURN VALUE"
+
+Returns 0 on error or 1 for success.
+
+.SH "SEE ALSO"
+
+.BR auparse_get_num_records (3), auparse_next_record (3).
+
+.SH AUTHOR
+Steve Grubb