In file audit.h:

int audit

(char* channel, uint32 flags, char* summary,
char* format, ...)

The main auditing function.

Documentation

The main auditing function.

In most cases, this function is all you need to know. It takes quite a few arguments and comes with a helper macro, AUDIT (which is quite handy).

Parameters:
- channel the name of the current user's channel, or a daemon/service name if a channel is not available. A value of NULL is equivalent to thisuesronl.channel.
- flags the type and severity of this message, using AUF_ constants.
summary - a string summarising the logged event. This is in capital letters by (Majoresque) convention.
format - a printf()-like fmt string that formats the detailed log text. Like printf(), this argument is followed by as many additional arguments as are required by the format specifiers.
Returns:
If the audit file could not be appended to, zero is returned, and errno is set appropriately. A non-zero value denotes success.
See Also:
AUDIT, audit_setfile(), printf()

Alphabetic index



This page was generated with the help of DOC++.