Share this page

# lr.getDebugMessage

Returns the current message logging settings.

Message 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 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.

Log Level | C Language Constants | Object Oriented Constants | Value
--- | --- | --- | ---
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 Runtime Trace | LR_MSG_CLASS_FULL_TRACE | lr.MSG_CLASS_FULL_TRACE | 8
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_ERROR | lr.MSG_CLASS_JIT_LOG_ON_ERROR | 512

## Parameterization

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

## Example

Copy code

    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;
    }

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: