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

lr_end_transaction_instance

Marks the end of a transaction instance.

C Language

int lr_end_transaction_instance (long parent_handle, int status); 
Example: lr_end_transaction_instance Transaction Functions

Arguments

Name Comments
parent_handle The handle returned by lr_start_transaction_instance at the creation of the instance.
status The transaction status.

The lr_end_transaction_instance function marks the end of a transaction instance and records the amount of time it took to perform the transaction. To indicate a transaction instance to be analyzed, place the lr_start_transaction_instance function before the transaction, and the lr_end_transaction_instance function after the transaction.

You can manually set the status of the transaction instance or you can allow the script to detect it automatically. To manually set the status, you perform a manual check within the code of your script (see example) evaluating the return code of a function. For the "succeed" return code, set the transaction status to LR_PASS. For a "fail" return code, set the status to LR_FAIL. For an "aborted" return code, set the status to LR_STOP.

To instruct the script to automatically detect the status, specify LR_AUTO. The script returns the detected.

Return Values

This function returns 0 on success, and a negative number on failure.

Parameterization

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