lr_get_debug_message

Returns the current message logging settings.

unsigned int lr_get_debug_message( );
Alphabetical Listing - C Language Utility Functions

Return Values

lr_get_debug_message returns runtime message settings for logging. The first table below shows the base values, one of which is always returned. The second table shows values that can be ORed with other values to refine the setting.

Log LevelC Language ConstantsObject Oriented ConstantsValue
DisabledLR_MSG_CLASS_DISABLE_LOGlr.MSG_CLASS_DISABLE_LOG0
BriefLR_MSG_CLASS_BRIEF_LOGlr.MSG_CLASS_BRIEF_LOG1
Extended LogLR_MSG_CLASS_EXTENDED_LOGlr.MSG_CLASS_EXTENDED_LOG16

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

Log LevelC Language ConstantsObject Oriented ConstantsValue
Result DataLR_MSG_CLASS_RESULT_DATAlr.MSG_CLASS_RESULT_DATA2
Parameter SubstitutionLR_MSG_CLASS_PARAMETERSlr.MSG_CLASS_PARAMETERS4
Full Runtime TraceLR_MSG_CLASS_FULL_TRACElr.MSG_CLASS_FULL_TRACE8

Only on error.

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

LR_MSG_CLASS_JIT_LOG_ON_ERRORlr.MSG_CLASS_JIT_LOG_ON_ERROR512

Parameterization

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

Concept Link IconSee Also

Example

In the following example, the lr_get_debug_message function retrieves the runtime logging settings, performs a bitwise operation, and sends an appropriate message.

int msg_level;
msg_level=lr_get_debug_message( );

/* Check if message level is "Data Returned by Server" and "Parameter Substitution" */
if ((msg_level & LR_MSG_CLASS_RESULT_DATA) && (msg_level & LR_MSG_CLASS_PARAMETERS))
    lr_output_message("Current message level is result data and parameters.");


/* Check for standard logging */
if (msg_level & LR_MSG_CLASS_BRIEF_LOG)
    lr_output_message("Logging is enabled.");