IInkAnalyzer::GetAlternatesForContextNodes method

Retrieves analysis alternates for the nodes in a specified IContextNodes collection.

Syntax

HRESULT GetAlternatesForContextNodes(
  [in]  IContextNodes      *pContextNodes,
  [in]  ULONG              ulMaximumAlternates,
  [out] AnalysisAlternates **ppAlternates
);

Parameters

pContextNodes [in]

The IContextNodes collection for which the analysis alternatives are returned.

ulMaximumAlternates [in]

The maximum number of alternatives to return.

ppAlternates [out]

The IAnalysisAlternates object containing the analysis alternatives.

Return value

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

Remarks

Caution

To avoid a memory leak, call IUnknown::Release on ppAlternates when you no longer need to use the object.

The top IAnalysisAlternate is returned as the first alternate of the collection.

The IContextNode objects in pContextNodes do not have to represent adjacent areas of the document.

For each analysis hint in nodes, the IInkAnalyzer returns only the top alternate.

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

See also

IInkAnalyzer

IAnalysisAlternate

IAnalysisAlternates

IInkAnalyzer::GetAlternates Method

IInkAnalyzer::GetAlternatesForStrokes Method

IInkAnalyzer::ModifyTopAlternate Method

IInkAnalyzer::ModifyTopAlternateWithConfirmation Method

Ink Analysis Reference