Method ITcPostCyclicCaller:RemovePostModule

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

Syntax

virtual HRESULT TCOMAPI
RemovePostModule(STcPostCyclicEntry* pEntry)=0;

Parameters

pEntry: (type: STcPostCyclicEntry) refers to the list entry which should be removed from the internal list of the cyclic caller.

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.

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

Description

Similar to the method AddPostModule() the smart pointer for the cyclic caller is used as list entry when the module instance should be removed from cyclic caller.

Declaration and usage of smart pointer:

ITcPostCyclicCallerInfoPtr m_spPostCyclicCaller;

if (
m_spPostCyclicCaller ) {
m_spPostCyclicCaller->RemovePostModule(m_spPostCyclicCaller);

}

m_spPostCyclicCaller = NULL;