Share this page

# lr.vuser_status_message

Sends a message to the Vuser status area.

    int lr.vuser_status_message( String message );

Message Functions | Java Syntax

## Arguments

Name | Comments
--- | ---
format C Language | A formatted string. If it is a literal string, enclose it with quotation marks. Use the standard Message Formatting that is available for printf to set the format for the expressions you want to print.
exp 1, exp 2,.. exp n C Language | The expressions (variables) to be formatted and printed.
message Object Oriented | A string containing the message to send to the Output window. See Java String Arguments.

The lr.vuser_status_message function sends a string to the Status area of the Controller. It also sends the string to the Vuser log. When run from VuGen, the message is sent to output.txt.

## Return Values

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

## Parameterization

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

## Example

The Vuser status area usually displays the Vuser state: Ready, Running, Paused, Done:Passed, etc. The lr.vuser_status_message function is useful for displaying more detailed information about the Vuser run. In the following example, lr.vuser_status_message specifies when the Vuser execution reaches a specific point:

//Indicate when the Vuser reaches line 10 of the Actions method.

lr.vuser_status_message ("reached line 10 in Actions");

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: