IInkAnalyzer::GetAnalysisHints method

Gets all of the analysis hint IContextNode objects that are attached to the IInkAnalyzer.

Syntax

HRESULT GetAnalysisHints(
  [out] IContextNodes **ppAnalysisHints
);

ppAnalysisHints [out]: A pointer to all the analysis hint IContextNode objects in the IInkAnalyzer.

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

Caution

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

This method returns an empty collection if no analysis hint nodes are attached to the IInkAnalyzer.

An analysis hint node is an IContextNode with a context node type of AnalysisHint (see IContextNode::GetType and Context Node Types).

To add context information to the hint, use IContextNode::AddPropertyData with the pPropertyDataId parameter set to one of the globally unique identifiers (GUIDs) in the Analysis Hint Properties constants.

To find which property values are set on a context node, use IContextNode::GetPropertyDataIds. To find the value of a property, use IContextNode::GetPropertyData.

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