IAnalysisWarning::GetBackgroundError method

Retrieves the error code for the background ink analysis operation if an error occurred.

Syntax

HRESULT GetBackgroundError();

Parameters

This method has no parameters.

Return value

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

Remarks

If an error occurs within a background analysis operation, the IInkAnalyzer cannot return the error code because it is occurring in a different thread. Instead, the _IAnalysisEvents::Results event handler receives an IAnalysisStatus that contains an IAnalysisWarning with an AnalysisWarningCode of AnalysisWarningCode_BackgroundException. This IAnalysisWarning contains the error code for the background analysis operation. In general, your _IAnalysisEvents::Results event handler will return this error code so that it can be handled elsewhere in your application.

Requirements

See also

IAnalysisWarning

IAnalysisStatus

IInkAnalyzer::BackgroundAnalyze Method

_IAnalysisEvents::Results

AnalysisWarningCode

Ink Analysis Reference