IInkAnalyzer::Abort method

Cancels the current analysis operation.

Syntax

HRESULT Abort(
  [out] IAnalysisRegion **ppAbortedRegion
);

Parameters

ppAbortedRegion [out]

A pointer to an IAnalysisRegion that represents the dirty region (see IInkAnalyzer::GetDirtyRegion Method) of the current analysis operation.

Return value

For a description of the return values, see Classes and Interfaces - Ink Analysis.

Remarks

Call IUnknown::Release on ppAbortedRegion when you no longer need to use the object.

This method cancels the current analysis operation.

When ppAbortedRegion is NULL, this method performs the abort as normal, because this indicates that the caller has no interest in the return value.

IInkAnalyzer::Abort Method silences the _IAnalysisEvents::Results and _IAnalysisEvents::Activity events for the current analysis operation.

IInkAnalyzer::Abort Method runs asynchronously until the current background analysis operation is canceled. Because the cancellation process is asynchronous, the application can perform other tasks while the current analysis opertions is canceled.

If no analysis operations are in progress, this method returns an empty analysis region.

If one analysis operation is in progress, this method cancels the operation.

If both synchronous and asynchronous analysis operations are in progress, this method cancels the synchronous operation.

If this method is called more than once for the same analysis operation, the first call returns the dirty region for the operation, and the subsequent calls return an empty region.

If your application maintains its own data structure that is synchronized with that of the IInkAnalyzer, calling IInkAnalyzer::Abort Method can leave your document with partial results. To avoid this, do not call IInkAnalyzer::Abort Method between the time the IInkAnalyzer receives the _IAnalysisProxyEvents::InkAnalyzerStateChanging event and the time the IInkAnalyzer receives the _IAnalysisEvents::IntermediateResults or _IAnalysisEvents::Results event.

For more information about synchronizing your application data with the ink analyzer, see Data Proxy with Ink Analysis.

Requirements

See also

IInkAnalyzer

IInkAnalyzer::Analyze Method

IInkAnalyzer::BackgroundAnalyze Method

IInkAnalyzer::GetDirtyRegion Method

IInkAnalyzer::SetDirtyRegion Method

Ink Analysis Reference