Utility Functions and C Language Reference > Utility Functions: C Language (lr_) > Alphabetical Listing > lr_set_transaction_instance_status

lr_set_transaction_instance_status

Sets the status of a transaction instance.

C Language

int lr_set_transaction_instance_status( int status, long trans_handle );
Example: lr_set_transaction_instance_status Transaction Functions

Arguments

Name Comments
status One of the Transaction Status constants for pass, fail, or stop. The auto status is not applicable.
trans_handle The handle to a transaction instance

Thelr_set_transaction_instance_status function sets the status of the open transaction with the transaction handle trans_handle. The handle was returned by lr_start_transaction_instance.

This transaction's lr_end_transaction_instance statement must use automatic status assignment by passing a Transaction Status of auto as its status parameter.

A transaction's status is defined in the status parameter of lr_end_transaction_instance. If this status is LR_AUTO the value is automatically assigned. By default, this value is LR_PASS signifying a successful transaction. lr_set_transaction_instance_status changes this default value to status.

For more information on transaction instances, see lr_start_transaction_instance.

Return Values

This function returns 0 on success and a negative value on failure.

Parameterization

You cannot use standard parameterization for any arguments in this function.