FC_EtUserCommandToString

FC_EtUserCommandToString - General Information

Overview

Type:	Function
Available as of:	V1.0.0.0

Task

Converting an enumeration element of the type ET_UserCommand from the SlcRemoteController 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_etUserCommand	ET_UserCommand	The ET_UserCommand 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 -> diagnostic message

Output

Data type

Description

q_etDiag

General, library-independent statement on the diagnostic.

A value unequal to GD.ET_Diag.Ok corresponds to a diagnostic message.

q_etDiagExt

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 i_etUserCommand input.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	Ok	0	Ok
InputParameterInvalid	UnknownUserCommand	16	The provided user command is incorrect.

The enumeration was converted into text successfully.

UnknownUserCommand

Enumeration name:	UnknownUserCommand
Enumeration value:	16
Description:	The provided user command is incorrect.

Cause	Solution
At the input i_etUserCommand, a number was transferred which value cannot be related to any element of ET_UserCommand.	At the input i_etUserCommand, an element of the enumeration ET_UserCommand has to be transferred.