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

lr.output_message

Sends a message to log files, output windows, and other test report summaries.

JavaScript

function lr.output_message(  message  )

VBScript

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

Arguments

Name Comments
message The message to send to the output window.

The lr.output_message function sends a message with the script section and line number to output windows log files, and other test report summaries.

For details regarding the output for each product, see the products' user guides.

When a script is run in VuGen, the output file is output.txt.

To send an error message to the output window or log, use the lr.error_message function. It is not recommended that you send a message to the output window or agent log in the middle of a transaction, as it will lengthen the execution time. To send a message to thelog but not the output window, use lr.log_message.

To send a message to the output file, you must enable logging in the run-time settings, and select Always send messages. If you select Send messages only when an error occurs, there is no output from this function.

To issue a message without including the location details, use lr.message.

statement

Output

lr.log_message("a message") a message
lr.output_message("a message") Actions.java (4): a message

Note: Do not send null pointers as arguments to string formats e.g.
     char *str = NULL;
     lr.output_message("%s", str)

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.