FC_EtArmConfigurationToString

 

FC_EtArmConfigurationToString - General Information

Overview

Type:

Function

Available as of:

V2.8.2.0

Versions:

Current version

This chapter provides information on:

oTask

oDescription

oInterface

oReturn Value

oDiagnostic Messages

Task

Converting an enumeration element of the type ET_ArmConfiguration 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_etArmConfiguration

ET_ArmConfiguration

The ET_ArmConfiguration 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 -> Diagnositc message

Return Value

Data type

Description

STRING[80]

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

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

Ok

0

Ok

InputParameterInvalid

UnknownArmConfiguration

202

The arm configuration is indeterminable.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

Reading the ET_ArmConfiguration value as text was successful.

UnknownArmConfiguration

Enumeration name:

UnknownArmConfiguration

Enumeration value:

202

Description:

The arm configuration is indeterminable.

Issue

Cause

Solution

The arm configuration is indeterminable.

Reading the ET_ArmConfiguration value as text was unsuccessful.

The value transferred at the input i_etArmConfiguration is indeterminable.

At the input i_etArmConfiguration, a value of ET_ArmConfiguration must be transferred.