FB_HomeSetPos - RegisterLoggerPoint (Method)

Overview

Type:	Method
Available as of:	1.4.0.0

Task

The method registers the internal logger point in the Application Logger.

Description

The function block contains a logger point implemented for the Application Logger. After successfully calling-up this method, the function block sends messages to the Application Logger via this logger point. This method is identical to the call-up of the RegisterLoggerPoint method at APL.FB_LoggerPoint.

After registration:

oThe function block automatically sends messages to the Application Logger.

oThe ET_LogLevel enumeration (logger level) describes the type and importance of a message.

oDepending on the respective function block, various information is forwarded within a message (e.g. a list of diagnostic outputs).

Interface

Input	Data type	Description
i_ifParent	APL.IF_LoggerPoint	The parent logger point under which the logger point of the function block shall be registered. The global variable G_ifApplicationLogger is also a logger point.
i_sName	STRING[80]	The name of the function block logger point which shall be displayed in the Application Logger must be defined here.

Output	Data type	Description
q_etDiag	GD.ET_Diag	General, library-independent statement on the diagnostic. A value not equal to ET_Diag.Ok corresponds to an error message.
q_etDiagExt	ET_DiagExt	POU-specific output on the diagnostic. q_etDiag = ET_Diag.Ok -> Status message q_etDiag <> ET_Diag.Ok -> Error message

Output

Data type

Description

q_etDiag

GD.ET_Diag

General, library-independent statement on the diagnostic.

A value not equal to ET_Diag.Ok corresponds to an error message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = ET_Diag.Ok -> Status message

q_etDiag <> ET_Diag.Ok -> Error message

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	Ok	0	Ok
InputParameterInvalid	MaxNumberOfLoggerPointsExeeded	318	The maximum number of logger points is exceeded.
InputParameterInvalid	ParentInvalid	316	The parent is invalid.
InputParameterInvalid	ParentNotRegistered	317	The parent is not registered.
UnexpectedProgramBehavior	UnexpectedDiagExt	17	DiagExt is unintended.

MaxNumberOfLoggerPointsExeeded

Enumeration name:	MaxNumberOfLoggerPointsExeeded
Enumeration value:	318
Description:	The maximum number of logger points is exceeded.

Issue	Cause	Solution
-	It was attempted to register more than APL.Gc_udiMaxNumberOfLoggerPoints logger points in the application logger.	The global parameter APL.Gc_udiMaxNumberOfLoggerPoints must be increased.

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

The logger point was successfully registered in the Application Logger.

ParentInvalid

Enumeration name:	ParentInvalid
Enumeration value:	316
Description:	The parent is invalid.

Issue	Cause	Solution
-	An invalid object has been transferred at the input i_ifParent.	At the input i_ifParent an object of the type APL.FB_LoggerPoint or APL.IF_ApplicationLogger has to be transferred.

ParentNotRegistered

Enumeration name:	ParentNotRegistered
Enumeration value:	317
Description:	The parent is not registered.

Issue	Cause	Solution
-	The logger point transferred at the input i_ifParent is not registered in the Application Logger.	The logger point transferred at the input i_ifParent must be registered in the Application Logger first.

UnexpectedDiagExt

Enumeration name:	UnexpectedDiagExt
Enumeration value:	17
Description:	DiagExt is unintended.

Issue	Cause	Solution
-	An error occurred in the internal execution.	Please inform the support team about this error.