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

lr.message

Sends a message to the log and output window.

JavaScript

function lr.message(  message  )

VBScript

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

Arguments

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

The lr.message function sends a message to the log file and output window. When run in VuGen, the output file is output.txt.

Use lr.log_message instead of this function to send the message only to the log file. This conserves the network and controller resources required for sending messages to the output.

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.

In the log file, this function does not list the location and line number from where the message was issued. To issue a message with those details, use lr.output_message.

statement

Output

lr.message("a message") a message
lr.output_message("a message") Action(4): a 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.