FC_EtControlLoopParameterToString - 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_ControlLoopParameter 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_etName

ET_ControlLoopParameter

The ET_ControlLoopParameter value that has to be converted.

Output

Data type

Description

q_etDiag

GD.ET_Diag

General library-independent statement on the diagnostic.

A value not equal 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 i_etName.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

Ok

0

Successful

InputParameterInvalid

ControlLoopParameterUnknown

57

The control loop parameter is indeterminable.

ControlLoopParameterUnknown

Enumeration name:

ControlLoopParameterUnknown

Enumeration value:

57

Description:

The control loop parameter is indeterminable.

Issue

Cause

Solution

Reading the ET_ControlLoopParameter value as text was not successful.

The value transferred at the input i_etName is indeterminable.

At the input i_etName, a value of ET_ControlLoopParameter must be transferred.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Successful

Reading the ET_ControlLoopParameter value as text was successful.