NAME

xdas_put_event_info - add specific event information to an audit record buffer

SYNOPSIS

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

DESCRIPTION

xdas_put_event_info() is a member of the XDAS Event Submission API Option Conformance class.

The xdas_put_event_info() function adds event information to an audit record or overwrites existing information. If the combination of information submitted and already present in the audit record referred to by audit_record_descriptor, is insufficient to evaluate applicable pre-selection criteria, the function returns XDAS_S_NO_DECISION_YET to the caller. If there is sufficient information for evaluation of applicable pre-selection checks the XDAS_S_COMPLETE or XDAS_S_NO_AUDIT are returned to the caller. Multiple calls to xdas_put_event_info may be made. For any individual parameter, information supplied in this call will overwrite any previous information supplied.

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 caller must have the XDAS_AUDIT_SUBMIT authority.

If successful, the function returns [XDAS_S_COMPLETE], [XDAS_S_NO_DECISION_YET] or [XDAS_S_NO_AUDIT]. If [XDAS_S_NO_AUDIT] is returned, audit_record_descriptor. is no longer a valid reference to an audit record.

Note:

An implementation may reclaim any storage associated with the audit record descriptor when [XDAS_S_NO_AUDIT] is returned.

If [XDAS_S_NO_DECISION_YET] is returned, then the caller should continue to construct the audit record by subsequent calls to xdas_put_event_info().

The arguments for xdas_put_event_info() 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)

The handle to the XDAS server, obtained from a previous call to xdas_initialize_session().

audit_record_descriptor (in)

The handle to the audit record, obtained from a previous call to xdas_start_record().

event_number (optional,in)

The event number of the detected event. If specified as a NULL value then the event number currently associated with audit_record_descriptor is unchanged. Otherwise event_number overwrites the current value. Only event numbers configured as registered by the implementation shall be valid. Any other event number shall result in the return of [XDAS_S_INVALID_EVENT_NO].

outcome (optional,in)

The outcome of the event determined by the caller. If specified as a NULL value then the outcome code currently associated with audit_record_descriptor is unchanged by this call. Otherwise outcome_code overwrites the current value. Only the outcome codes listed in XDAS Event Outcome Codes are valid.

initiator_information (optional,in)

The information describing the initiator in the format required by the XDAS common audit format. If specified as XDAS_C_NO_BUFFER the current initiator information associated with the audit_record_descriptor supplied is unchanged by this call. Otherwise the contents of initiator_information overwrite the current value associated with audit_record_descriptor.

target_information (optional,in)

The information on the target of the event in the format required by the XDAS common audit format. If specified as XDAS_C_NO_BUFFER the current target information associated with the audit_record_descriptor supplied is unchanged by this call. Otherwise the contents of target_information overwrite the current value associated with audit_record_descriptor.

event_information (optional,in)

The event specific information that is to be added to the audit record specified by audit_record_descriptor. If specified as XDAS_C_NO_BUFFER the current event specific information associated with the audit_record_descriptor supplied is unchanged by this call. Otherwise the contents of event_information overwrite the current value associated with audit_record_descriptor.

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_INFO]

The specified audit event information is not valid.

[XDAS_S_INVALID_EVENT_NO]

The specified event number is not valid.

[XDAS_S_INVALID_INITIATOR_INFO]

The initiator information supplied has a syntax error.

[XDAS_S_INVALID_OUTCOME]

The specified outcome is not valid.

[XDAS_S_INVALID_RECORD_DESCRIPTOR]

The specified audit record descriptor is not valid.

[XDAS_S_INVALID_TARGET_INFO]

The specified target information has a syntax error.

[XDAS_S_NO_AUDIT]

The event specified does not need to be audited.

[XDAS_S_NO_DECISION_YET]

The audit service has insufficient information to decide if the event requires auditing.

[XDAS_S_NOT_SUPPORTED]

The called function is not supported by this implementation.

ERRORS

No other errors are defined.

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