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

lr_stop_transaction_instance

Freezes reporting statistics for a transaction instance specified by its handle.

C Language

double lr_stop_transaction_instance (long parent_handle);
Example: lr_stop_transaction_instance and lr_resume_instance Transaction Functions

Arguments

Name Comments
parent_handle A unique transaction handle.

After a call to lr_stop_transaction_instance, statistics returned by the "get" Transaction Functions reflect only the data up to the call, until lr_resume_transaction_instance is called. The specified transaction instance must have been opened with lr_start_transaction_instance.

Data collection, however, is not interrupted. After the call to lr_resume_transaction_instance, the "get" functions return all data since the start of the transaction instance. Furthermore, the final results when the test is analyzed will reflect the total values, including the periods in between the transaction stop and resume.

If lr_resume_transaction_instance is not called, the final results reflect the statistics only until the call to lr_stop_transaction_instance.

The parent_handle is the value returned from the call to lr_start_transaction_instance that created the instance.

lr_stop_transaction_instance and lr_resume_transaction_instance can be used to conditionally collect information about either the beginning, or all of the transaction.

Note that you will not be able to differentiate in analysis between iterations when lr_stop_transaction_instance was called and iterations where it was not.

For more flexible ways recording transaction times conditionally, see lr_start_sub_transaction, lr_set_transaction,and lr_start_timer.

Return Values

This function returns the duration of the current transaction instance in seconds if it succeeds, and a negative number if an error occurs.

Parameterization

Parameterization is not applicable to this function.