Share this page

# lr.error_message

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

    int lr.error_message( String message );

Message Functions | Java Syntax

## Arguments

Name | Comments
--- | ---
format C Language | A formatted string to send to the Output window. You may specify a literal string in quotation marks or use the standard Message Formatting that is available for printf.
exp1, exp2,.. expn C Language | The expressions or variables to be formatted.
message Java | A string containing the error message to send to the Output window. See Java String Arguments.

The lr.error_message function sends an error message to the application's output window, 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.

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

lr.set_debug_message calls can affect the output from lr.error_message.

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

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

## Return Values

If this function succeeds, it returns the length of the message that was sent. If the function fails, it returns a negative number.

## Parameterization

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

## Example

In the following example, lr.error_message sends a message to the output window or log file if login fails:

    try {
        lr.start_transaction("create");
        _carmel = _carmelhome.create();
        lr.end_transaction("create", lr.AUTO);
    }
    catch (Throwable t) {
        lr.end_transaction("create", lr.FAIL);
        lr.error_message("Exception occur while calling EJB create");
        t.printStackTrace();
    }

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