Method ITcCyclicCaller:RemoveModule

Remove a module instance from being called by a cyclic caller.

Syntax

virtual HRESULT TCOMAPI
RemoveModule(STcCyclicEntry* pEntry)=0;

Method ITcCyclicCaller:RemoveModule 1: Return value

If successful, S_OK ("0") or another positive value will be returned, cf. Return values. Extended messages refer in particular to the column HRESULT in ADS Return Codes.

Parameter

Name

Type

Description

pEntry

STcCyclicEntry

Refers to the list item to be removed from the internal list of the cyclic caller.

The method returns E_FAIL if the entry is not in the internal list.

Comparable with the AddModule() method, the smart pointer is used for the cyclic caller as a list item if the module instance is to be removed from the cyclic caller.

Declaration and use of the Smart Pointer:

ITcCyclicCallerInfoPtr m_spCyclicCaller;

if (
m_spCyclicCaller ) {
m_spCyclicCaller->RemoveModule(m_spCyclicCaller);
}
m_spCyclicCaller = NULL;