Share this page

# lr.error_message

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

## C#

    void lr.error_message( String message );

## VB.NET

    Sub lr.error_message( ByVal message  As String )

Message Functions

## Arguments

Name | Comments
--- | ---
message | The string to send to the Output window.

The lr.error_message function sends an error message to the product's output windows, log files, and other test report summaries.

The message size is limited to 5 KB.

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

If Runtime 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.

If you send a message to the Output window in the middle of a transaction, 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 runtime 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

No value returned.

## Parameterization

You cannot use standard parameterization for any arguments in this function.

## Example

In the this example, there is a parameter, <iteration> that reports the iteration number of the test. The lr.error_message function sends a message indicating the current iteration number.

Copy code

      public int login(string username, string password)
           {
            //emulate failed login
            return lr.FAIL;
            }
      int status = login("username","password");

      if (status == lr.FAIL) {

        lr.error_message( "Error at iteration #" + lr.eval_string( "{iteration}" ) );
        return -1;
        }
    return 0;

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: