FC_CheckSubModuleList - General Information

Overview

Type:

Function

Available as of:

V1.0.4.0

Task

The function checks if the user has incorporated all submodules into the template correctly. It recognizes user errors in the Update_Structs action. It is used in XXXModuleController (e.g. AxisModuleController).

Description

If a verification was not successful, XXXModuleController should not access this pointer. Activation is prevented for AxisModuleController.

Interface

Input

Data type

Description

i_dwModuleType

DWORD

Module type that shall be checked in the list of the sub modules.

i_udiModuleId

UDINT

The number of the equipment module in which the XXXModuleController is called up. It is used to enter an exception into the exception list.

i_sModuleName

STRING[80]

The name of the equipment module in which the XXXModuleController is called up. It is used to enter an exception into the exception list.

i_etSource

ET_ExceptionSource

The exception source for the module type of the XXXModuleController. It is used to enter an exception into the exception list.

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

The enhanced default interface of the equipment module in which the XXXModuleController is called up.

iq_stExceptionList

ST_ExceptionList

The global exception list.

iq_stLogDataList

ST_LogDataList

The global logging list.

Return Value

Data type

Description

BOOL

TRUE: All checks are OK.

FALSE: A check was unsuccessful.

Diagnostic Messages

q_etDiag

q_etDiagExt

Enumeration value

Description

OK

Ok

0

Ok

ExecutionAborted

MissingExtInit

56

Initialization of the Ext structure failed.

InputParameterInvalid

SubModuleItfPointerDuplicate

143

A pointer onto an interface of a submodule exists twice.

MissingExtInit

Enumeration name:

MissingExtInit

Enumeration value:

56

Description:

Initialization of the Ext structure failed.

Issue

Cause

Solution

-

The enhanced interface at the iq_stExt input contains invalid values.

Verify the initialization of the submodules.

Verify the call-ups of the FC_UpdateAddInterfaceStruct functions of the submodules.

Ok

Enumeration name:

Ok

Enumeration value:

0

Description:

Ok

All checks of the submodules were executed successfully.

SubModuleItfPointerDuplicate

Enumeration name:

SubModuleItfPointerDuplicate

Enumeration value:

143

Description:

A pointer onto an interface of a submodule exists twice.

Issue

Cause

Solution

-

In the list of the submodules two pointers refer to the same submodule.

Verify the initialization of the submodules.

Verify the call-ups of the FC_UpdateAddInterfaceStruct functions of the submodules.