IF_Multicarrier - SetApplicationLoggerLogLevel (Method)

Overview

Type:

Method

Available as of:

V1.0.0.0

Task

Setting the logger level of the Application Logger .

Description

With the method SetApplicationLoggerLogLevel, you can specify the logger level of the Application Logger.

Three different logger levels from the Application Logger are supported:

  • UserAction: Displays only messages due to a user action (for example when you send a command)

  • StatusMessage: Displays messages due to a user action as well as additional status information

  • DebugMessage: Displays messages due to a user action, status information as well as additional parameters

NOTE: For performance reasons, set the logger level as low as possible. Only increase the logger level when required for analyzing and testing purposes.

For more information on the logger levels, refer to the enumeration ET_LogLevel.

The following graphics display examples for the different logger levels of Application Logger messages:
Logger level UserAction
Logger level StatusMessage
Logger level DebugMessage

NOTE: You can use the filtering options of the Application Logger e.g. to filter the column Source for logging information about the carriers.

For more information on the filtering options of the Application Logger, refer to the Menu Commands Online Help.

Inputs

Input

Data type

Description

i_etLoglevel

APL.ET_Loglevel

The logger level of the Application Logger .

The level specifies which kind of information is shown in the messages of the Application Logger.

Outputs

Output

Data type

Description

q_xError

BOOL

Indicates TRUE if an error has been detected. For details, refer to q_etResult and q_sResultMsg.

q_etResult

ET_Result

Provides diagnostic and status information as a numeric value.
If q_xError = FALSE, q_etResult provides status information.
If q_xError = TRUE, q_etResult provides diagnostic/error information.

q_sResultMsg

STRING [255]

Provides additional diagnostic and status information as a text message.