FC_UpdateControlModuleStruct - General Information

Overview

Type:	Function
Available as of:	V1.0.4.0

Task

Function for initialization and update of values in an array of type ST_ControlModuleInterface.

Description

The function initializes and updates values of type ST_ControlModuleInterface in an array. The values that must be updated are addresses of interfaces which are designed Control Module. A control module is a normal function block, which is used to control specific hardware components. Such a function block has no typical characteristics of an equipment module. In the beginning and at the end of every online change, an update of the addresses is necessary.

Interface

Input	Data type	Description
i_udiControlModuleId	UDINT	Number / ID of the control module.
i_sControlModuleName	STRING[80]	Name of the control module.
i_udiControlModuleType	UDINT	Type of the control module. (For all function blocks that are not Schneider Electric specific you have to choose a value between 1000 and 2147483647. The range between 1 and 999 is reserved by Schneider Electric.)
i_udiNumberOfControlModules	UDINT	Number of the control modules in the array at the i_dwControlModulesItf and i_dwControlModulesAddItf inputs.
i_dwControlModulesAddItf	DWORD	Array default interfaces of the control modules
i_dwControlModulesItf	DWORD	Array of the additional interfaces of the control modules

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 an error message.
q_etDiagExt	ET_DiagExt	POU-specific output on the diagnostic. q_etDiag = ET_Diag.Ok -> Status message q_etDiag <> ET_Diag.Ok -> Error message

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 an error message.

q_etDiagExt

ET_DiagExt

POU-specific output on the diagnostic.

q_etDiag = ET_Diag.Ok -> Status message

q_etDiag <> ET_Diag.Ok -> Error message

Input/Output	Data type	Description
iq_stExt	ST_StandardModuleInterfaceExt	Default interface of the node.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	Ok	0	Ok
InputParameterInvalid	ControlModuleIdRange	63	The ID of the control module is outside the valid range.
InputParameterInvalid	ControlModuleAddItfInvalid	62	The additional interface of the control module is invalid.
InputParameterInvalid	ControlModulesItfInvalid	65	The interface of the control module is invalid.
InputParameterInvalid	NumberOfControlModulesRange	64	The number of control modules is outside the valid range.

ControlModuleAddItfInvalid

Enumeration name:	ControlModuleAddItfInvalid
Enumeration value:	62
Description:	The additional interface of the control module is invalid.

Issue	Cause	Solution
-	The additional control module is invalid	The ControlModulesAddItf variable must be >0

ControlModuleIdRange

Enumeration name:	ControlModuleIdRange
Enumeration value:	63
Description:	The ID of the control module is outside the valid range.

Issue	Cause	Solution
-	The ID of the control module is outside the value range	The variable ControlModuleId must not be <1

ControlModulesItfInvalid

Enumeration name:	ControlModulesItfInvalid
Enumeration value:	65
Description:	The interface of the control module is invalid.

Issue	Cause	Solution
-	The interface of the control module is invalid	The variable ControlModulesItf must not be = 0

NumberOfControlModulesRange

Enumeration name:	NumberOfControlModulesRange
Enumeration value:	64
Description:	The number of control modules is outside the valid range.

Issue	Cause	Solution
-	The number of control modules is outside the specified range	The value of ControlModulesItf must not be = 0

Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

The UpdateControlModuleStruct function works without exceptions