lr.getDebugMessage

Returns the current message logging settings.

ExampleMessage Functions

Syntax

            
            lr.getDebugMessage( );

The lr.getDebugMessage function returns the current log runtime settings. These settings determine what information is output. The log settings are specified with the runtime settings dialog, or by using the lr.setDebugMessage function.

The debug messages are sent to the output window.

To evaluate the returned value, you can perform a bitwise AND operation. This allows you to determine which options are set.

Return Values

lr.getDebugMessage 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 log settings that Only on error is ORed with.

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

function Action(){
   var msg_level;
   msg_level=lr.getDebugMessage();

   /* 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.outputMessage("Current message level is result data and parameters.");
   /* Check for standard logging */

   if (msg_level & lr.MSG_CLASS_BRIEF_LOG)
       lr.outputMessage("Logging is enabled.");
return 0;
}