IInkAnalyzer::FindNodesOfTypeInSubTree method

Article
01/07/2021

Retrieves all of the IContextNode objects of the specified type that are descendants of the specified IContextNode object.

Syntax

HRESULT FindNodesOfTypeInSubTree(
  [in]  const GUID          *pNodeType,
  [in]        IContextNode  *pContextNodeToSearchFrom,
  [out]       IContextNodes **ppContextNodesFound
);

Parameters

pNodeType [in]: The GUID that specifies the node type.
pContextNodeToSearchFrom [in]: The IContextNode object whose descendants are searched.
ppContextNodesFound [out]: The IContextNodes collection containing all nodes of type pNodeType that are descendants of pContextNodeToSearchFrom.

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.

If the IInkAnalyzer does not contain the pContextNodeToSearchFrom node, this method returns an error code.

The pNodeType property must contain a globally unique identifier (GUID) from the Context Node Types constants.

If the IInkAnalyzer contains no such IContextNode, 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