FC_UpdateAddInterfaceStruct - General Information

Overview

Type:	Function
Available as of:	V1.0.0.0

This chapter provides information on:

Task
Description
Interface
Return Value
Diagnostic Messages

Task

This function is used to handle FB_RoboticModule submodules within the Update_Structs action of a node Equipment Module.

Description

The function updates link to the RoboticModule within the module hierarchy of the template. By using this link, you can activate different modules from the template.

Interface

Input	Data type	Description
i_pdwSubModuleAddInterfaces	POINTER TO DWORD	The address of the array in which the additional interfaces of the node are 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 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
q_sMsg	STRING[80]	Event-triggered message that gives additional information on the diagnostic state.

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

q_sMsg

STRING[80]

Event-triggered message that gives additional information on the diagnostic state.

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

Return Value

Data type	Description
BOOL

Diagnostic Messages

q_etDiag	q_etDiagExt	Enumeration value	Description
OK	Ok	0	Ok
InputParameterInvalid	SubModuleAddInterfacesInvalidPointer	18	The submodule add interfaces pointer is invalid.
InputParameterInvalid	SubModuleConstantRange	19	The submodule constant is out of range.

Ok

Enumeration name:	Ok
Enumeration value:	0
Description:	Ok

The update of the additional interface was successful.

SubModuleAddInterfacesInvalidPointer

Enumeration name:	SubModuleAddInterfacesInvalidPointer
Enumeration value:	18
Description:	The submodule add interfaces pointer is invalid.

Issue	Cause	Solution
The update of the additional interface was not successful.	An uninitialized pointer (0) was transferred at the input i_pdwSubModuleAddInterfaces.	Ensure that at the input i_pdwSubModuleAddInterfaces the address of the array is transferred in which the additional interfaces of the node are managed.

SubModuleConstantRange

Enumeration name:	SubModuleConstantRange
Enumeration value:	19
Description:	The submodule constant is out of range.

Issue	Cause	Solution
The update of the additional interface was not successful.	The value transferred at the input i_udiSubmoduleConstant is outside the valid range.	At the input i_udiSubmoduleConstant, a value greater than or equal to 1 must be transferred.