IInkAnalyzer::FindInkLeafNodesForStrokes method

Article
01/07/2021

Retrieves the ink leaf nodes that contain the specified strokes.

Syntax

HRESULT FindInkLeafNodesForStrokes(
  [in]  ULONG         ulStrokeIdsCount,
  [in]  LONG          *plStrokeIds,
  [out] IContextNodes **ppContextNodesFound
);

Parameters

ulStrokeIdsCount [in]: The number of stroke identifiers passed in.
plStrokeIds [in]: An array of the stroke identifiers.
ppContextNodesFound [out]: The collection of IContextNode objects that contain all the ink leaf nodes that contain the strokes with identifiers in the plStrokeIds array.

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 ppContextNodesFound when you no longer need to use the object.

Leaf nodes do not contain child nodes. Ink nodes contain stroke data. Examples of ink leaf nodes are InkWord, InkDrawing, andInkBullet IContextNode objects. For more information, see Context Node Types.

If no nodes contain the specified strokes, an empty IContextNodes collection is returned. Similarly, if ulStrokeIdsCount is zero, an empty IContextNodes collection is returned.

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