docs/audit_log_user_message.3

   1 .TH "AUDIT_LOG_USER_MESSAGE" "3" "Oct 2006" "Red Hat" "Linux Audit API"
   2 .SH NAME
   3 audit_log_user_message \- log a general user message
   4 .SH SYNOPSIS
   5 .B #include <libaudit.h>
   6 .sp
   7 .B int audit_log_user_message(int audit_fd, int type, const char *message,
   8 const char *hostname, const char *addr, const char *tty,
   9 int result)
  10
  11 .SH DESCRIPTION
  12 This function will log a message to the audit system using a predefined
  13 message format. This function should be used by all console apps that do
  14 not manipulate accounts or groups. The function parameters are as follows:
  15
  16 .nf
  17 audit_fd - The fd returned by audit_open
  18 type - type of message, ex: AUDIT_USYS_CONFIG, AUDIT_USER_LOGIN
  19 message - the message text being sent
  20 hostname - the hostname if known, NULL if unknown
  21 addr - The network address of the user, NULL if unknown
  22 tty - The tty of the user, if NULL will attempt to figure out
  23 result - 1 is "success" and 0 is "failed"
  24 .fi
  25
  26 .SH "RETURN VALUE"
  27
  28 It returns the sequence number which is > 0 on success or <= 0 on error.
  29
  30 .SH "ERRORS"
  31
  32 This function returns \-1 on failure. Examine errno for more info.
  33
  34 .SH "SEE ALSO"
  35
  36 .BR audit_log_user_comm_message (3),
  37 .BR audit_log_acct_message (3),
  38 .BR audit_log_user_avc_message (3),
  39 .BR audit_log_semanage_message (3).
  40
  41 .SH AUTHOR
  42 Steve Grubb