Loadrunner Functions

Loadrunner Functions

Below are some frequently used functions

lr_output_message()

Through this function, you can get the value of the "parameter" which is substituted in the script during the run

lr_output_message("Value: %s", lr_eval_string("{Value}"));

lr_error_message()

This will give only error messages during run.

lr_eval_string()

Converting a string to a parameter

Declare your string at the beginning of your script:

 char String [500] = "Value to be saved";

Use the lr_save_string function to save this value to a parameter:

  lr_save_string(String, "NameOfParam");

Using this function you could also simply type in the string using 

  lr_save_string("Value to be saved", "NameOfParam");

Converting a parameter to a string

Again declare a string at the top of the script make sure that the array has enough values to hold all the characters in the parameter + 1 (the extra one is required because ‘C’ strings require an extra space for a null character to terminate the string).

  char String[500];

You then need to use the sprintf function to save your parameter to a string:

 sprintf(String, "%s", lr_eval_string("{NameOfParam}"));

Above functions are some important Loadrunner functions which you might use. Below is the list of all Loadrunner functions. Functions highlighted in yellow are the ones I would suggest you to remember.

lr.advance_param	Advances to the next available parameter.
lr.debug_message	Sends a debug message to the LoadRunner output window or Business Process Monitor agent log file.
lr.decrypt	Decrypts an encoded string.
lr.empty	Returns an Variant whose value is Empty.
lr.end_sub_transaction	Marks the end of a sub-transaction.
lr.end_transaction	Marks the end of a transaction.
lr_error_message	Sends an error message to the log file and LoadRunner output window with location details.
lr.eval_double	Returns the double value of the parameter.
lr.eval_int	Returns the integer value of a parameter.
lr.eval_long	Returns the long value of the parameter.
lr.eval_string	Returns the string argument after evaluating embedded parameters.
lr.exit	Exits from the script, action, or iteration.
lr.get_attrib_double	Returns the value of a command line parameter as a double
lr.get_attrib_long	Returns the value of a command line parameter as a long integer.
lr.get_attrib_string	Returns the value of a command line parameter as a string.
lr.get_debug_message	Returns the current message logging settings
lr.get_group_name	Returns the name of the LoadRunner Vuser's group.
lr.get_host_name	Returns the name of the host executing the script.
lr.get_master_host_name	Returns the name of the machine running the LoadRunner Controller or Console.
lr.get_transaction_duration	Returns the duration of a transaction.
lr.get_transaction_think_time	Returns the think time of a transaction.
lr.get_vuser_ip	Returns the IP address of a LoadRunner Vuser.
lr.log	Sends a message to the log file of the Business Process Monitor agent or LoadRunner Vuser.
lr.log_message	Sends a message to the Business Process Monitor agent log file or the LoadRunner Vuser log.
lr.message	Sends a message to the log file and output window.
lr.missing	Returns an Variant whose value is Missing.
lr.next_row	Advances to the next row in the parameter data file.
lr.output_message	Sends a message to the log file and output window with location details.
lr.peek_events	Indicates a point to search for events.
lr.resume_transaction	Resumes reporting transaction data within a script.
lr.save_double	Saves a double value as a parameter.
lr.save_int	Saves an integer as a parameter.
lr.save_long	Saves a long value as a parameter.
lr.save_string	Saves a null-terminated string as a parameter.
lr.set_debug_message	Sets the message level.
lr.set_transaction	Creates a completed transaction.
lr.start_sub_transaction	Starts a sub-transaction specified by its parent's name.
lr.start_transaction	Marks the beginning of a transaction.
lr.stop_transaction	Freezes reporting of transaction data.
lr.think_time	Pauses execution between commands in a script.
lr.vuser_group	Returns the name of the Vuser group.
lr.vuser_id	Returns the Vuser ID.
lr.vuser_status_message	Sends a message to the Vuser Status area in the LoadRunner Controller or Console window.
lr.user_data_point	Records a user-defined data sample.

Informational Functions

lr_end_timer	Stops a timer.
lr_get_host_name	Returns the name of the host executing the script.
lr_get_master_host_name	Returns the name of the machine running the LoadRunner Controller or Tuning Module Console .
lr_get_vuser_ip	Returns the IP address of the current Vuser. Not applicable for products that do not run Vusers.
lr_start_timer	Starts a timer.
lr_user_data_point	Records a user-defined data sample.
lr_user_data_point_ex	Records a user-defined data sample and enables logging option.
lr_user_data_point_instance	Records a user-defined data sample and correlates it to a transaction instance.
lr_user_data_point_instance_ex	Records a user-defined data sample and enables logging option.
lr_whoami	Returns information about a Vuser executing the script. Not applicable for products that do not run Vusers.

o   Message Functions

lr_debug_message	Sends a debug message to the LoadRunner output window or Application Management agent log file.
lr_error_message	Sends an error message to the LoadRunner output window or Application Management agent log file.
lr_get_debug_message	Returns the current message logging settings.
lr_log_message	Sends a message to the Vuser log file.
lr_message	Sends a message to the log file and output window.
lr_output_message	Sends a Vuser message to the log file and output window with location information.
lr_set_debug_message	Sets a message class for output messages.
lr_vuser_status_message	Sends a message to the Vuser status area in the LoadRunner Controller or Tuning Module Console.

Informational Functions

lr.get_host_name	Returns the name of the host executing the script.
lr.get_group_name	Returns the name of the LoadRunner Vuser's group.
lr.get_master_host_name	Returns the name of the machine running the LoadRunner Controller or Console.
lr.get_vuser_ip	Returns the IP address of a LoadRunner Vuser.
lr.vuser_group	Returns the name of the Vuser group.
lr.vuser_id	Returns the Vuser ID.
lr.user_data_point	Records a user-defined data sample.

Run-Time Functions

lr_abort	Aborts script execution.
lr_continue_on_error	Specifies an error handling method.
lr_disable_ip_spoofing	Disables IP Spoofing.
lr_enable_ip_spoofing	Enables IP Spoofing.
lr_exit	Exits from the script, action, or iteration.
lr_load_dll	Loads an external DLL.
lr_param_increment	Increments the value of a numerical parameter
lr_peek_events	Indicates a point to search for LoadRunner events..
lr_rendezvous	Sets a rendezvous point in a Vuser script.
lr_think_time	Pauses execution between commands in a script.

Transaction Functions

lr_end_sub_transaction	Marks the end of a sub-transaction.
lr_end_transaction	Marks the end of a transaction.
lr_end_transaction_instance	Marks the end of a transaction instance.
lr_fail_trans_with_error	Sets the status of open transactions to LR_FAIL and sends an error message.
lr_get_trans_instance_duration	Returns the duration of a transaction instance specified by its handle.
lr_get_trans_instance_status	Returns the current status of a transaction instance.
lr_get_trans_instance_think_time	Gets the think time of a transaction instance specified by its handle.
lr_get_trans_instance_wasted_time	Gets the wasted time of a transaction instance by its handle.
lr_get_transaction_duration	Gets the duration of a transaction by its name.
lr_get_transaction_status	Gets the current status of a transaction.
lr_get_transaction_think_time	Gets the think time of a transaction by its name.
lr_get_transaction_wasted_time	Gets the wasted time of a transaction by its name.
lr_resume_transaction	Resumes collecting transaction data.
lr_resume_transaction_instance	Resumes collecting transaction instance data.
lr_set_transaction	Create a transaction manually.
lr_set_transaction_instance_status	Sets the status of a transaction instance.
lr_set_transaction_status	Sets the status of open transactions.
lr_set_transaction_status_by_name	Sets the status of a transaction.
lr_start_sub_transaction	Marks the beginning of a sub-transaction.
lr_start_transaction	Marks the beginning of a transaction.
lr_start_transaction_instance	Starts a nested transaction specified by its parent's handle.
lr_stop_transaction	Stops the collection of transaction data.
lr_stop_transaction_instance	Stops collecting data for a transaction specified by its handle.
lr_wasted_time	Removes wasted time from all open transactions.