xdas_start_record(XDAS)

Synopsis

#include <sys/xdas.h>

OM_uint32 xdas_start_record(
	OM_uint32 *minor_status,
	const xdas_audit_ref_t *das_ref,
	xdas_audit_desc_t *audit_record_descriptor,
	const OM_unit32 event_number,
	const OM_uint32 outcome,
	const xdas_buffer_t *initiator_information,
	const xdas_buffer_t *target_information,
	const xdas_buffer_t *event_info);

Description

xdas_start_record(XDAS) returns an audit_record_descriptor handle to the audit record to the caller. If the optional parameters are not specified in the call, then the audit record is initialized but requires fully populating by subsequent calls to xdas_put_event_info(XDAS).

If the optional parameters are specified, xdas_start_record(XDAS) determines whether a specified event should be audited given the event_number, outcome and initiator_information supplied. If the event should be audited, a valid audit_record_descriptor is returned to the caller. If the audit event does not require auditing then audit_record_descriptor is set to NULL.

The caller must have the XDAS_AUDIT_SUBMIT authority.

If successful, the function returns XDAS_S_COMPLETE.

Although several parameters are optional in this call, a caller shall have populated all the parameters, even when empty, in one or more sequences of calls to xdas_start_record(XDAS) and xdas_put_event_info(XDAS) before a call to xdas_commit_record(XDAS) can be successful.

Arguments

minor_status

(Output) Provides additional information when the function returns XDAS_S_FAILURE.

das_ref

(Input) A handle to the XDAS service, obtained from a previous call to xdas_initialise_session(XDAS).

audit_record_descriptor

(Output) A pointer to an audit record, populated as defined by the optional input parameters. If the event does not need to be audited, a NULL pointer is returned.

event_number

(Optional input) The event_number of the detected event.

outcome

(Optional input) The outcome of the event as determined by the caller.

initiator_information

(Optional input) The available information describing the initiator in the format required by the XDAS common audit format.

target_information

(Optional input) Information on the target of the event in the format required by the XDAS common audit format.

event_info

(Optional input) Information specific to the event.

Return values

XDAS_S_AUTHORISATION_FAILURE

The caller does not possess the required authority.

XDAS_S_COMPLETE

Successful completion.

XDAS_S_FAILURE

An implementation specific error or failure has occurred, such as missing required parameters, or a malloc failure.

XDAS_S_INVALID_DAS_REF

The audit service handle supplied does not point to the audit service.

XDAS_S_INVALID_EVENT_NO

The event number specified is invalid.

XDAS_S_INVALID_INITIATOR_INFO

The initiator information specified has a syntax error.

XDAS_S_INVALID_OUTCOME

The outcome supplied is invalid.

XDAS_S_INVALID_TARGET_INFO

The target information specified has a syntax error.

XDAS_S_INVALID_EVENT_INFO

The event information specified is invalid.

XDAS_S_NO_AUDIT

The specified event does not need to be audited.

XDAS_S_UNCERTAIN_AUDIT

There is uncertainty as to whether the specified event requires auditing.

References