NAME

xdas_start_record - initialize an audit record

SYNOPSIS

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() is a member of the XDAS Event Submission API Option Conformance class.

The xdas_start_record() function returns a 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.

If the optional parameters are specified, xdas_start_record 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() and xdas_put_event-info() before a call to xdas_commit_record() shall be successful.

The arguments for xdas_start_record() are:

minor_status (out)

An implementation specific return status that provides additional information when [XDAS_S_FAILURE] is returned by the function.

das_ref (in)

Handle to the XDAS service, obtained from a previous call to xdas_initialize_session().

audit_record_descriptor (out)

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,in)

The event_number of the detected event.

outcome (optional,in)

The outcome of the event as determined by the caller.

initiator_information (optional,in)

The available information describing the initiator in the format required by the XDAS common audit format.

target_information (optional,in)

Information on the target of the event in the format required by the XDAS common audit format.

event_info (optional,in)

Information specific to the event.

RETURN VALUE

The following XDAS status codes shall be returned:

[XDAS_S_AUTHORIZATION_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.

[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 not valid.

[XDAS_S_INVALID_INITIATOR_INFO]

The initiator information specified has a syntax error.

[XDAS_S_INVALID_OUTCOME]

The outcome supplied is not valid.

[XDAS_S_INVALID_TARGET_INFO]

The target information specified has a syntax error.

[XDAS_S_INVALID_EVENT_INFO]

The event information specified is not valid.

[XDAS_S_NO_AUDIT]

The specified event does not need to be audited.

[XDAS_S_NOT_SUPPORTED]

The called function is not supported by this implementation.

[XDAS_S_UNCERTAIN_AUDIT]

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

ERRORS

No other errors are defined.

[??] Some characters or strings that appear in the printed document are not easily representable using HTML.