FC_UpdateAddInterfaceStruct

FC_UpdateAddInterfaceStruct - General Information

Overview

Type:	Function
Available as of:	V1.0.0.0

Task

This function is used to handle UnwinderModule submodules within the Update_Structs action of a node equipment module.

Description

The function updates the link to the UnwinderModule within the module hierarchy of the template. With this link different modules can be activated from the template.

Interface

Input	Data type	Description
i_pdwSubModuleAddInterfaces	POINTER TO DWORD	The address in which the additional interface of the node is managed must be transferred to the input.
i_udiSubModuleConstant	UDINT	The number of the module within the node must be transferred to the input.

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

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

Input/Output	Data type	Description
iq_stUnwinderModuleItf	ST_ModuleInterface	The additional interface of the UnwinderModule must be transferred to the input.

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	Ok	0	Proceeding normally, satisfactory or under control, or other affirmative acknowledgement.
InputParameterInvalid	SubModuleAddInterfacesInvalidPointer	26	Invalid pointer to SubModuleAddInterfaces.
InputParameterInvalid	SubModuleConstantRange	27	SubModuleConstant is outside of the valid range.

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

The link for the UnwinderModule has been updated successfully in the template.

SubModuleAddInterfacesInvalidPointer

Enumeration name:	SubModuleAddInterfacesInvalidPointer
Enumeration value:	26
Description:	Invalid pointer to SubModuleAddInterfaces.

Issue	Cause	Solution
-	An uninitialized pointer was transferred at the input i_pdwSubModuleAddInterfaces	Ensure to always initialize the pointer by using TPL.FC_UpdateNodeModuelAddInterfaceStruct before calling this function

SubModuleConstantRange

Enumeration name:	SubModuleConstantRange
Enumeration value:	27
Description:	SubModuleConstant is outside of the valid range.

Issue	Cause	Solution
-	SubModuleConstant is outside of the valid range	Ensure to transfer a value equal or greater than 0 at the input i_udiSubModuleConstant