FB_CoreStation - RegisterLoggerPoint (Method)

Overview

Type:

Method

Available as of:

V1.0.0.0

Task

Registering the station to the Application Logger.

Description

With the method RegisterLoggerPoint, the station function block FB_CoreStation is registered as a logger point to the Application Logger.

The station function block is defined by the property i_sName. The property i_sName defined in the function block FB_CoreStation (see FB_CoreStation) is also used for registering the function block to the Application Logger.

The input i_ifParent specifies the parent logger point under which the present logger point is to be registered in the logger point tree.

For more information on the Application Logger, refer to: Using the Application Logger.

Inputs

Input

Data type

Description

i_ifParent

APL.IF_LoggerPoint

Parent logger point under which the logger point of the function block is registered.

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.

Access Specifier

The method RegisterLoggerPoint is assigned the access specifier FINAL. This helps to protect the method from being overwritten.

For more information, see Mandatory Access Specifiers.