Utility Functions and C Language Reference > Utility Functions: .NET (lr.) > Alphabetical Listing > lr.get_debug_message

lr.get_debug_message

Returns the current message logging settings.

C#

unsigned int lr.get_debug_message( );  

VB.NET

Function lr.get_debug_message( ) as UInteger
Example: lr.get_debug_message Message Functions

Arguments

Name Comments
N/A  

The lr.get_debug_message function returns the current log run-time settings . The settings determine what information is sent output. The log settings are specified with the run-time settings dialog, or by using the lr.set_debug_message function.

The debug messages are sent to the output window or log file.

To evaluate the returned value, you can perform a bitwise AND operation. This allows you to determine which options are set. See the C syntax Example: lr_get_debug_message.

Debug Level Values

lr.get_debug_message returns run-time message settings for logging. The first table below shows the base values, one of which is always returned. The other tables show values that can be ORed with other values to refine the setting.

Log Level C Language Constants Object Oriented Constants Value
Disabled LR_MSG_CLASS_DISABLE_LOG lr.MSG_CLASS_DISABLE_LOG 0
Brief LR_MSG_CLASS_BRIEF_LOG lr.MSG_CLASS_BRIEF_LOG 1
Extended Log LR_MSG_CLASS_EXTENDED_LOG lr.MSG_CLASS_EXTENDED_LOG 16

The following are ORed with the Extended Log message setting used to further refine the setting.

Result Data LR_MSG_CLASS_RESULT_DATA lr.MSG_CLASS_RESULT_DATA 2
Parameter Substitution LR_MSG_CLASS_PARAMETERS lr.MSG_CLASS_PARAMETERS 4
Full Run-Time Trace LR_MSG_CLASS_FULL_TRACE lr.MSG_CLASS_FULL_TRACE 8

Only on error can be ORed with all other message settings.
Which messages are sent on error depends on the other settings.

Only on error. LR_MSG_CLASS_JIT_LOG_ON_ERROR lr.MSG_CLASS_JIT_LOG_ON_ERROR 512

Return Values

The log-settings bit map.

Parameterization

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