IAnalysisAlternate::GetAlternateNodes method

Gets the IContextNode objects that are associated with this alternate.

Syntax

HRESULT GetAlternateNodes(
  [out] IContextNodes **ppAlternateNodes
);

Parameters

ppAlternateNodes [out]

A pointer to the IContextNodes collection that contains IContextNode objects that are associated with this alternate.

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 *ppAlternateNodes when you no longer need to use the context node collection.

This method returns the leaf context nodes that are associated with this alternate. Examples of leaf nodes are InkWord, TextWord, Image, InkDrawing, and InkBullet context nodes. For more information, see IContextNode::GetType and Context Node Types.

Because they correspond to alternates, these IContextNode objects are not descendants of the IInkAnalyzer object's root IContextNode (see IInkAnalyzer::GetRootNode Method) unless they are the top alternate, which is the first element in an IAnalysisAlternates collection.

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

IAnalysisAlternate

IContextNode

IContextNodes

Ink Analysis Reference

System.Windows.Ink.AnalysisCore.AnalysisAlternateBase.AlternateNodes