audit_dpms_api.3 (2010 09)

a
audit_dpms_api(3) audit_dpms_api(3)
abort_on_data_error
If this option is present, audit_dpms_read_event()
aborts and returns an
error if a data error occurs while reading an event. If this option is not present,
audit_dpms_read_event()
prints a warning and skips over the event.
debug Writes debug information to stderr.
read The module will be used for reading. The
read option and write option cannot
both be specified. If neither
read
nor write is specified, then read is assumed.
silent Suppresses error messages. Without this option, error messages are printed to
stdout.
write The module will be used for writing. The
read option and write option cannot
both be specified. If neither
read nor write is specified, then read is assumed.
RETURN VALUES
All
audit_dpms_api()
interfaces return zero (AUDIT_DPMS_SUCCESS
) if the operation was success-
ful. Otherwise, the interfaces print an error message to stderr and return a non-zero value.
The common return values from the
audit_dpms_api()
interfaces are as follows:
AUDIT_DPMS_SUCCESS
The requested operation succeeded.
AUDIT_DPMS_HANDLE_ERROR
A problem was found with the dpmh handle.
AUDIT_DPMS_MEMORY_ERROR
An error occurred while attempting to allocate or deallocate memory.
AUDIT_DPMS_MODULE_DATA_ERROR
A problem was found with a DPMS service module’s data pointer.
AUDIT_DPMS_INVALID_ARGUMENT
An invalid function argument was specified.
AUDIT_DPMS_IO_ERROR
An I/O operation failed.
AUDIT_DPMS_UNSUPPORTED
The requested operation is not supported.
audit_dpms_start()
can also return the following errors:
AUDIT_DPMS_LOAD_ERROR
An error occurred while attempting to load a DPMS service module.
AUDIT_DPMS_OPEN_ERROR
A request to open a stream failed.
AUDIT_DPMS_VERSION_ERROR
A mismatch was found between the application and library versions.
audit_dpms_read_event() can also return the following errors:
AUDIT_DPMS_DATA_ERROR
A problem was found with the data format.
AUDIT_DPMS_EOF A request to read from a stream was terminated by end-of-file.
AUDIT_DPMS_INVALID_READ
A read was attempted and the audit_dpms_start() call specified that the
module was to be used only for writing.
audit_dpms_write_event() can also return the following errors:
AUDIT_DPMS_INVALID_WRITE
A write was attempted and the audit_dpms_start() call specified that
the module was to be used only for reading.
audit_dpms_register_filter() can also return the following errors:
AUDIT_DPMS_EVENT_CONF_ERROR
Failed to read audit configuration information from the
HP-UX 11i Version 3: September 2010 − 3 − Hewlett-Packard Company 3