IInkAnalyzer::SetHighestPriorityInkAnalysisRecognizer method

Article
01/07/2021

Moves the specified IInkAnalysisRecognizer to the first position in the IInkAnalyzer object's list of ink recognizers.

Syntax

HRESULT SetHighestPriorityInkAnalysisRecognizer(
  [in] IInkAnalysisRecognizer *pInkAnalysisRecognizer
);

Parameters

pInkAnalysisRecognizer [in]: The IInkAnalysisRecognizer to place in the first position.

Return value

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

Remarks

To get the list of ink recognizers in priority order, call IInkAnalyzer::GetInkAnalysisRecognizersByPriority Method.

This method does not affect the order of the rest of the IInkAnalysisRecognizer objects in the IInkAnalyzer object's list of ink recognizers.

The order of the ink recognizers returned by IInkAnalyzer::GetInkAnalysisRecognizersByPriority Method indicates the order in which the IInkAnalyzer evaluates the available IInkAnalysisRecognizer objects.

Use of the ink recognizers is evaluated based on their order in the list.

During ink analysis, the IInkAnalyzer iterates through the ink recognizers in its list until it finds a recognizer that supports the language and other properties of the strokes. This recognizer is used for ink recognition for those strokes.

If the IInkAnalyzer does not find an IInkAnalysisRecognizer that supports a set of strokes during analysis, the IInkAnalyzer generates an IAnalysisWarning with a warning code of AnalysisWarningCode_InkAnalysisRecognizerNotInstalled (see IAnalysisWarning::GetWarningCode).

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Header	IACom.h (also requires IACom_i.c)
DLL	IACom.dll