aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/audit/docs/audit_getloginuid.3
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/audit/docs/audit_getloginuid.3')
-rw-r--r--framework/src/audit/docs/audit_getloginuid.325
1 files changed, 25 insertions, 0 deletions
diff --git a/framework/src/audit/docs/audit_getloginuid.3 b/framework/src/audit/docs/audit_getloginuid.3
new file mode 100644
index 00000000..6a2b4ee8
--- /dev/null
+++ b/framework/src/audit/docs/audit_getloginuid.3
@@ -0,0 +1,25 @@
+.TH "AUDIT_GETLOGINUID" "3" "Oct 2006" "Red Hat" "Linux Audit API"
+.SH NAME
+audit_getloginuid \- Get a program's loginuid value
+.SH SYNOPSIS
+.B #include <libaudit.h>
+.sp
+uid_t audit_getloginuid(void);
+
+.SH DESCRIPTION
+This function returns the task attribute loginuid.
+
+.SH "RETURN VALUE"
+
+This function returns the loginuid value if it was set. It will return a \-1 if loginuid was unset. However, since uid_t is an unsigned type, you will see the converted value instead of \-1.
+
+.SH "ERRORS"
+
+This function returns \-1 on failure. However, in the event of a real error, errno would be set. The function can set errno based on failures of open, read, or strtoul.
+
+.SH "SEE ALSO"
+
+.BR audit_setloginuid (3).
+
+.SH AUTHOR
+Steve Grubb