FC_SingleLoggerEntry - General Information

Overview

Type:

Function

Available as of:

V1.0.4.0

Task

Generating an entry in a global log data list.

Description

The function checks whether the global log data list has been released for writing. If this is the case, it enters the variables described at the input into the list.

The user can also use the function to enter an application-specific report. To this end, ET_LogDataFilter.User must be used as i_etReason. The user must determine the data and time stamp of the entry. For this purpose, the function FC_GetTimeStamp can be used. For application-specific reports, not all input parameters (e.g. i_diCmd, i_stReaction, ...) have to be occupied by meaningful values. i_sMsg can be used for a free text.

Interface

Input

Data type

Description

i_etReason

ET_LogDataFilter

Reason for the entry in the log data list.

i_dateDate

DATE

Date of the entry into the log data list.

i_todTime

TOD

Point in time of the entry into the log data list.

i_udiModuleId

UDINT

ID of the module that issued the entry.

i_sModuleName

STRING[80]

Name of the module that issued the entry.

i_diCmd

DINT

Command that just has been processed.

i_diStartStep

DINT

Step as of which the command table was processed.

i_stReaction

ST_Reaction

Reactions triggered due to an exception.

i_etDiag

GD.ET_Diag

General, library-independent statement on the diagnostic.

A value unequal GD.ET_Diag.Ok equates an error message.

i_udiDiagExt

UDINT

Value of the POU-specific statement on the diagnostic.

q_etDiag = GD.ET_Diag.Ok -> Status message

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

i_sDiagExt

STRING[80]

Name of the POU-specific statement on the diagnostic.

q_etDiag = GD.ET_Diag.Ok -> Status message

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

i_sMsg

STRING[80]

Event-triggered message which gives more detailed information on the diagnostic state.

i_etSource

ET_ExceptionSource

Origin/source of an exception.

i_xAutoQuit

BOOL

TRUE: The exception acknowledged itself.

Output

Data type

Description

q_etDiag

GD.ET_Diag

General, library-independent statement on the diagnostic.

A value unequal GD.ET_Diag.Ok equates an error 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 -> Error message

Input/Output

Data type

Description

iq_stLogDataList

ST_LogDataList

Global log data list into which the entry shall be made.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

Ok

0

Ok

UnexpectedProgramBehavior

InitLogDataListFailed

48

Initialization of the log data list failed.

InitLogDataListFailed

Enumeration name:

InitLogDataListFailed

Enumeration value:

48

Description:

Initialization of the log data list failed.

Issue

Cause

Solution

-

Initialization of the exception list failed. - An internal execution error has been detected.

Try to initialize the exception list using the FC_InitLogDataList function.

Please inform your Schneider Electric representative about this detected error.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

Successfully generated an entry into the global log data list.