ExecuteCurrentState (Method)

Overview

Type:	Interface
Available as of:	V1.4.2.0
Inherits from:	–

Description

If an instance of the FB_StateModelHandlerBase is assigned to the present unit control mode, this method is used to invoke the state method of the present state. For assigning an instance of the FB_StateModelHandlerBase to a unit control mode, the unit mode must be defined using the DefineUnitModeWithHandler() method.

Interface

Output	Data type	Description
q_etResult	ET_Result	Provides diagnostic and status information as a numeric value. If q_xError = FALSE, q_etResult provides status information. If q_xError = TRUE, q_etResult provides diagnostic/error information.
q_sResultMsg	STRING	Provides additional diagnostic and status information as a text message.

Output

Data type

Description

q_etResult

ET_Result

Provides diagnostic and status information as a numeric value.

If q_xError = FALSE, q_etResult provides status information.

If q_xError = TRUE, q_etResult provides diagnostic/error information.

q_sResultMsg

STRING

Provides additional diagnostic and status information as a text message.

Return Value

Output	Data type	Description
ExecuteCurrentState	BOOL	Indicates TRUE if the method is completed successfully.