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

lr.debug_message

Sends a debug message to the log file.

JavaScript

function lr.debug_message(  message_level, message  )

VBScript

Function lr.debug_message(  message_level, message  )
Example: Debug Message Levels Message Functions

Arguments

Name Comments
message_level One of the Message Log Run-Time Settings. Disabled does not apply.

The lr.debug_message function sends a debug message when the specified message level is active. If the specified message level is not active, a message is not issued. You can set the active message level to MSG_CLASS_BRIEF_LOG or MSG_CLASS_EXTENDED_LOG from the user interface or by using lr.set_debug_message. To determine the current level, use lr.get_debug_message.

Note that you can also specify multiple message levels with an OR separator ("|"). If any one of the levels are active (from the UI), the message is issued to the Output window. If none of the levels are active, the message is not issued.

The message is sent to the output window. To display the debug messages in the output window or log file, use the Expert Mode Settings. Activate Expert Mode (Tools > Expert Mode) and then choose Tools > Options > Debug Information and select the General check box.

Return Values

On success, returns the number of characters written, not including the terminating null-character. On error, returns a negative value.

Parameterization

Standard parameterization is not available for this function.