FC_EtPreControllerModeToString

FC_EtPreControllerModeToString - General Information

Overview

Type:	Function
Available as of:	V1.0.0.0

Task

An enumeration of the ET_PreControllerMode type has to be converted to a string.

Description

The PreControllerMode by the i_etPreControllerMode input is converted to a string that represents the name of the enumeration.

Interface

Input	Data type	Description
i_etPreControllerMode	ET_PreControllerMode	The enumeration that has to be converted to a string.

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[80]	The enumeration 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	PreControllerModeInvalid	51	PreControllerMode is invalid.

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.

PreControllerModeInvalid

Enumeration name:	PreControllerModeInvalid
Enumeration value:	51
Description:	PreControllerMode is invalid.

Issue	Cause	Solution
-	An invalid value was transferred at the input i_etPreControllerMode.	Only elements of the enumeration table ET_PreControllerMode are allowed to be transferred to the input i_etPreControllerMode.