Method ITcIoCyclicCaller:RemoveIoDriver

Unregister a module instance from being called by a cyclic I/O caller.

Syntax


virtual HRESULT TCOMAPI 
RemoveIoDriver(STcIoCyclicEntry* pEntry)=0;

Parameters

pEntry: (type: STcIoCyclicEntry) refers to the list entry which should be removed from the internal list of the cyclic I/O 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

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

Declaration and use of the smart pointer:

ITcIoCyclicCallerInfoPtr 
m_spIoCyclicCaller;

if ( m_spIoCyclicCaller )
{
 m_spIoCyclicCaller->RemoveIoDriver(m_spIoCyclicCaller);
}
m_spCyclicCaller = NULL;