Utility Functions and C Language Reference > Utility Functions: Java (lr.) > Alphabetical Listing > lr_debug_message

lr_debug_message

Sends a debug message to the log file.

C Language

int lr_debug_message( unsigned int message_level, char *format, ... ); 
Example: lr_debug_message Message Functions

Java Language

int lr.debug_message( int message_level, String message );
Example: lr.debug_message Message Functions Java Syntax

Arguments

Name Comments
message_level One of the Message Log Run-Time Settings. Disabled does not apply.
format A formatted string which is the message to be sent to the log file. You may use the standard Message Formatting that is available for printf.

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, the message is issued to the Output window.

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.

lr_set_debug_message calls can affect the output.

Return Values

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

Parameterization

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

Concept Link IconSee Also