CancelAsyncRead Method (IAppPlugin)

This method cancels outstanding asynchronous read or advise requests. The server shall respond via the client's IOPCHDA_DataCallback::OnCancelComplete method unless a FAILED error code is returned from the call. If a FAILED error code is returned, there will be no callback to the client's IOPCHDA_DataCallback::OnCancelComplete method.

Syntax

Visual Basic
C#

'Usage
 
Dim instance As IAppPlugin
Dim cancelID As Integer
Dim value As Integer
 
value = instance.CancelAsyncRead(cancelID)

int CancelAsyncRead( 
   int cancelID
)

Parameters

cancelID: Identifies the request to be cancelled.

Return Value

HRESULTS success/error code.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

IAppPlugin Interface
IAppPlugin Members