FB_ApplicationLoggerHandler - GetLogEntry (Method)

Overview

Type:	Method
Available as of:	V1.0.4.0

Task

Read out a logger message from the application logger.

Description

This method searches in the ring buffer for logger messages inside the application logger for a message with the given ID. If this message is found, a copy of the logger entry including the message and the source information is returned.

Interface

Input	Data type	Description
i_udiId	UDINT	The identification number of the logger message that has to be read.

Output	Data type	Description
q_stLogEntry	ST_LogEntry	The logger entry with message and source information.
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_stLogEntry

ST_LogEntry

The logger entry with message and source information.

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	Ok	0	Ok
InputParameterInvalid	IdInvalid	11	The Id is invalid.
UnexpectedProgramBehavior	ApplicationLoggerItfNotSupported	14	The application logger interface is not supported.
UnexpectedProgramBehavior	ApplicationLoggerNotSet	13	The application logger has not been set.
UnexpectedProgramBehavior	UnexpectedFeedback	3	A feedback value was invalid.

ApplicationLoggerItfNotSupported

Enumeration name:	ApplicationLoggerItfNotSupported
Enumeration value:	14
Description:	The application logger interface is not supported.

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

ApplicationLoggerNotSet

Enumeration name:	ApplicationLoggerNotSet
Enumeration value:	13
Description:	The application logger has not been set.

Cause	Solution
The global variable G_ifApplicationLogger has been changed.	Make sure not to write the variable G_ifApplicationLogger.
Output q_etDiag shows GD.ET_Diag.UnexpectedProgramBehavior An error has been detected in the internal execution.	Contact your Schneider Electric service representative.

Cause

Solution

The global variable G_ifApplicationLogger has been changed.

Make sure not to write the variable G_ifApplicationLogger.

Output q_etDiag shows GD.ET_Diag.UnexpectedProgramBehavior

An error has been detected in the internal execution.

Contact your Schneider Electric service representative.

IdInvalid

Enumeration name:	IdInvalid
Enumeration value:	11
Description:	The Id is invalid.

Cause	Solution
At the input i_udiId, an invalid value has been transferred.	At the input i_udiId, a value between udiFirstLogEntryId and udiLastLogEntryId has to be transferred.

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

The LogEntry data is returned.

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.