Utility Functions and C Language Reference > Utility Functions: Scripting Languages (lr.) > Alphabetical Listing > lr.error_message

lr.error_message

Sends an error message with location details to the output windows, log files, and other test report summaries.

JavaScript

function lr.error_message(  message  )

VBScript

Function lr.error_message(  message  )
Example: lr.error_message Message Functions

Arguments

Name Comments
message A string containing the error message to send to the Output window.

The lr.error_message function sends an error message to product output windows log files, and other test report summaries. For details regarding the output for each product, see the products' user guides.

To send a special notification that is not specifically an error message, use lr.output_message.

If Run-time settings > General > Miscellaneous > Fail open transactions on lr.error_message is selected, calling lr.error_message will fail the transaction in addition to sending the message. If you want to save the elapsed time in spite of the transaction failure, capture the time with lr.get_transaction_duration before calling lr.error_message, then create a transaction to report the time with lr.set_transaction.

It is not recommended that you send a message to the Output window in the middle of a transaction, as it will lengthen the execution time. Instead, use lr.log_message to send the message only to the Vuser log file. This conserves the resources required for sending messages to the output window.

VuGen displays the message text of the lr.error_message function in the Execution log in red, using Error code 17999. Note that this function sends a message to the output even when logging is disabled in the run-time settings.

In the Vuser Execution log, this function lists the location and line number from where the message was issued. To issue a message without those details, use lr.message.

Output of lr.error_message("output message") - Action(4):output message                

Output of lr.message("message") - message                                                                    

Return Values

On success, returns the length of the message that was sent. On failure, returns a negative number.

Parameterization

Standard parameterization is not available for this function.