FC_EtDiagToString

 

FC_EtDiagToString - General Information

Overview

Type:

Function

Available as of:

V1.0.1.0

Versions:

Current version

Task

Converting an enumeration element of the type ET_Diag of the PD_GlobalDiagnostics library into a string.

Description

Every enumeration element has a name or value. The return value of the function is the name of the enumeration element.

Interface

Input

Data type

Description

i_etDiag

ET_Diag

The ET_Diag value to be converted

Output

Data type

Description

q_etDiag

ET_Diag

General library-independent statement on the diagnostic.

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

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = ET_Diag.Ok -> Status message

q_etDiag <> ET_Diag.Ok -> Diagnostic message

Return Value

Data type

Description

STRING[80]

Name of the enumeration element that was transferred at the i_etMode input.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

Ok

0

Ok

InputParameterInvalid

UnknownDiag

1

Diag is indeterminable.

UnexpectedProgramBehavior

UnexpectedDiag

3

The Diag value was unintended.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

The enumeration has been successfully converted into text.

UnexpectedDiag

Enumeration name:

UnexpectedDiag

Enumeration value:

3

Description:

The Diag value was unintended.

Issue

Cause

Solution

-

An error has been detected and occurred in the internal execution.

At the i_etDiag input a number was transferred whose value could not be related to any element of ET_Diag.

Please inform the support team about this detected error.

UnknownDiag

Enumeration name:

UnknownDiag

Enumeration value:

1

Description:

Diag is indeterminable.

Issue

Cause

Solution

-

At the input i_etDiag a number was transferred whose value cannot be related to any element of ET_Diag.

At the input i_etDiag, an element of the enumeration ET_Diag must be transferred.