FC_EtControllerCommandToString

 

FC_EtControllerCommandToString - General Information

Overview

Type:

Function

Available as of:

V1.0.4.0

Inherits from:

-

Implements:

-

Task

Converting an enumeration element of the type ET_ControllerCommand 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_etControllerCommand

ET_ControllerCommand

The enumeration value that has to be converted.

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

Return Value

Data type

Description

STRING[80]

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

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

Ok

0

Operation successfully completed.

InputParameterInvalid

InputUnknown

53

Incorrect input argument.

InputUnknown

Enumeration name:

InputUnknown

Enumeration value:

53

Description:

Incorrect input argument.

Issue

Cause

Solution

-

The input value cannot be related to an element of the enumeration.

Verify the input.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Operation successfully completed.

The enumeration has been successfully converted into text.