FB_LoggerPoint - AddLogEntry (Method)

Overview

Type:	Method
Available as of:	V1.0.4.0

Task

Send a logger message to the application logger.

Description

This method has to be called to send a logger message to the application logger. This method can be called from different tasks.

The information that is given to the logger point during the call of RegisterLoggerPoint is linked to every message that was sent via this logger point and does not have to be included inside the message.

Interface

Input	Data type	Description
i_etLogLevel	ET_LogLevel	The logger level indicates the type and the priority of the message.
i_etDiag	GD.ET_Diag	The diagnostic for the logger message. Default value of the input is GD.ET_Diag.Ok.
i_udiDiagExt	UDINT	The ET_DiagExt of the logger message.
i_sMessage	STRING[255]	The freely definable logger message.

Output	Data type	Description
q_etDiag	GD.ET_Diag	General, library-independent statement on the diagnostic. A value unequal to GD.ET_Diag.Ok corresponds to a diagnostic message.
q_etDiagExt	ET_DiagExt	POU-specific output on the diagnostic. q_etDiag = GD.ET_Diag.Ok -> status message q_etDiag <> GD.ET_Diag.Ok -> diagnostic message

Output

Data type

Description

q_etDiag

GD.ET_Diag

General, library-independent statement on the diagnostic.

A value unequal to GD.ET_Diag.Ok corresponds to a diagnostic message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = GD.ET_Diag.Ok -> status message

q_etDiag <> GD.ET_Diag.Ok -> diagnostic message

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	LoggerDisabled	1	The application logger is disabled.
OK	MessageNotAdded	22	The message has not been added.
OK	Ok	0	Ok
ExecutionAborted	LoggerPointNotRegistered	24	The logger point is not registered.
UnexpectedProgramBehavior	ServiceNotRegistered	17	The service is not registered.
UnexpectedProgramBehavior	UnexpectedFeedback	3	A feedback value was invalid.

LoggerDisabled

Enumeration name:	LoggerDisabled
Enumeration value:	1
Description:	The application logger is disabled.

The logger message was not added to the application logger because the logging was disabled by the call of DisableLogger method of FB_ApplicationLogerHandler.

LoggerPointNotRegistered

Enumeration name:	LoggerPointNotRegistered
Enumeration value:	24
Description:	The logger point is not registered.

Cause	Solution
The logger point is not registered to the application logger.	The method RegisterLoggerPoint has to be called successfully once before logger messages can be sent.

MessageNotAdded

Enumeration name:	MessageNotAdded
Enumeration value:	22
Description:	The message has not been added.

The logger message was not added to the application logger because the ET_LogLevel of the message has a lower priority than the ET_LogLevel of the logger point.

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

The logger message has been added successfully to the application logger.

ServiceNotRegistered

Enumeration name:	ServiceNotRegistered
Enumeration value:	17
Description:	The service is not registered.

Cause	Solution
The application logger service is not registered.	The method RegisterCommunicationService of IF_ApplicationLogger has to be called successfully once before a logger message can be sent.
An error has been detected in the internal execution.	Contact your Schneider Electric service representative.

UnexpectedFeedback

Enumeration name:	UnexpectedFeedback
Enumeration value:	3
Description:	A feedback value was invalid.

Cause	Solution
An error has been detected in the internal execution.	Contact your Schneider Electric service representative.