FC_EtStateToString

FC_EtStateToString - General Information

Overview

Type:	Function
Available as of:	V1.0.0.0

Task

Convert the status messages of the FB_UnwinderModule to a string.

Description

The i_etState status message of the UnwinderModule from the ET_State enumeration list is converted to a string.

Interface

Input	Data type	Description
i_etState	ET_State	The state that has to be translated.

Output	Data type	Description
q_etDiag	GD.ET_Diag	General, library-independent statement on the diagnostic. A value not equal to 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

Output

Data type

Description

q_etDiag

General, library-independent statement on the diagnostic.

A value not equal to 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[20]	The state that was converted to a string.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	Ok	0	Proceeding normally, satisfactory or under control, or other affirmative acknowledgement.
InputParameterInvalid	StateRange	21	State is outside of the valid range.

Enumeration name:	Ok
Enumeration value:	0
Description:	Proceeding normally, satisfactory or under control, or other affirmative acknowledgement.

The enumeration has successfully been converted to a string.

StateRange

Enumeration name:	StateRange
Enumeration value:	21
Description:	State is outside of the valid range.

Issue	Cause	Solution
-	An invalid value was transferred at the input i_etState	Ensure that only elements from ET_State are transferred at the input i_etState