FC_EtOptionalEquipmentToString - General Information

Overview

Type:

Function

Available as of:

V1.0.0.0

Versions:

Current version

This chapter provides information on:

Task

Converting an enumeration element of the type ET_OptionalEquipment from this library to 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_etOptionalEquipment

ET_OptionalEquipment

The ET_OptionalEquipment 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 for 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 input i_etOptionalEquipment.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

Ok

0

Ok

InputParameterInvalid

UnknownOptionalEquipment

7

The optional equipment is indeterminable.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

Reading the ET_OptionalEquipment value as text was successful.

UnknownOptionalEquipment

Enumeration name:

UnknownOptionalEquipment

Enumeration value:

7

Description:

The optional equipment is indeterminable.

Issue

Cause

Solution

Reading the ET_OptionalEquipment value as text was not successful.

The value transferred at the input i_etOptionalEquipment is indeterminable.

Ensure that an element of the enumeration type ET_OptionalEquipment is transferred.