Alphabetical Listing

Before using these functions, you need to get a reference to the lr object. For example:

private LoadRunner.LrApi lr = new LoadRunner.LrApi();

Click one of the following functions for more information:

lr.abortAborts the execution of a script.
lr.advance_paramAdvances to the next available value in the parameter data file.
lr.continue_on_errorSpecifies an error handling method.
lr.cyberark_get_vaultQueries a protected password in a CyberArk Vault and Safe, and saves it to a parameter.
lr.debug_messageSends a debug message to the output window or log file.
lr.decryptDeprecated. Unmasks an encoded string during replay.
Use lr.unmask.
lr.emptyReturns a Variant whose value is Empty.
lr.end_sub_transactionMarks the end of a sub-transaction.
lr.end_transactionMarks the end of a transaction.
lr.error_messageSends an error message to the log file and output window with location details.
lr.evalReturns the string argument after evaluating embedded parameters.
lr.eval_doubleReturns the double value of the parameter.
lr.eval_intReturns the long integer value of a parameter.
lr.eval_longReturns the long integer value of a parameter.
lr.eval_stringReturns the string argument after evaluating embedded parameters.
lr.exitExits from the script, action, or iteration.
lr.get_attrib_doubleReturns the value of a command line parameter as a double
lr.get_attrib_longReturns the value of a command line parameter as a long integer.
lr.get_attrib_stringReturns the value of a command line parameter as a string.
lr.get_debug_messageReturns the current message logging settings
lr.get_host_nameReturns the name of the host executing the script.
lr.get_master_host_nameReturns the name of the machine running LoadRunner Controller.
lr.group_nameReturns the name of the Vuser's group.
lr.get_transaction_durationReturns the duration of a transaction.
lr.get_transaction_think_time

Returns the think time of a transaction.

lr.get_vuser_ipReturns the IP address of a Vuser.
lr.logSends a message to the log file.
lr.log_messageSends a message to the log file.
lr.missingReturns a variant whose value is Missing.
lr.messageSends a message to the log file and output window.
lr.next_rowAdvances to the next row in the parameter data file.
lr.output_messageSends a message to the log file and output window with location details.
lr.peek_eventsIndicates a point to search for events.
lr.read_fileReads a file into a parameter.
lr.rendezvousCreates a rendezvous point in the Vuser script.
lr.resume_transactionResumes 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_longSaves a long value as a parameter.
lr.save_stringSaves a null-terminated string as a parameter.
lr.set_debug_messageSets the message level.
lr.set_transactionCreates a completed transaction.
lr.scenario_id   Returns the current Scenario or Session step ID.
lr.sleepCalls the operating system's sleep command.
lr.start_sub_transactionStarts a sub-transaction specified by its parent's name.
lr.start_transactionMarks the beginning of a transaction.
lr.stop_transactionFreezes reporting of transaction data.
lr.think_timePauses execution between commands in a script.
lr.unmaskUnmasks an encoded string.
lr.user_data_pointRecords a user-defined data sample.
lr.vuser_groupReturns the name of the Vuser group.
lr.vuser_status_messageSends a message to the Vuser Status area in the Controller window.