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

lr_start_transaction_instance

Starts a transaction instance.

C Language

long lr_start_transaction_instance( char *transaction_name, long handle );
Example: lr_start_transaction_instance Transaction Functions

Arguments

Name Comments
transaction_name The name of the transaction.
handle The parent transaction's handle. A value of 0 instructs VuGen to create a new parent transaction.

The lr_start_transaction_instance function marks the beginning of a transaction instance. A transaction instance is an occurrence of a transaction with transaction_name. Instances are identified by their handle which distinguishes them from other instances of the same transaction.

This function enables multiple instances of a transaction to be created. Use transaction instances when the same transaction is required to be performed under different circumstances and an analysis of each circumstance is required.

By passing the handle of a parent transaction instance, the new instance will be considered a sub-transaction instance of the parent. Pass zero as the handle if there is no parent. For more information on sub-transactions, see lr_start_sub_transaction.

The function returns the handle of the transaction instance which identifies the instance. Note that each lr_start_transaction_instance statement must be matched with an lr_end_transaction_instance statement or it will be interpreted as an illegal command.

Note: Do not use the period character (.) in a transaction or sub-transaction name. The period character delimits transactions and sub-transactions. In analysis, a transaction name with a period will be interpreted as two transactions.

Return Values

This function returns a unique long number which identifies the specific transaction instance. On error, a negative number is returned.

Parameterization

All string arguments (char type) can be parameterized using standard parameterization.