IInkAnalyzer::GetNodesFromTextRange method

Article
01/07/2021

Retrieves a collection of IContextNode objects that are relevant to the specified text range for the specified context nodes.

Syntax

HRESULT GetNodesFromTextRange(
  [in, out] LONG          *plStart,
  [in, out] LONG          *plLength,
  [out]     IContextNodes **ppContextNodes,
  [in]      IContextNodes *pNodesToSearch = defaultvalue
);

Parameters

plStart [in, out]: A reference to the start of the text range in the pNodesToSearch portion of the recognized string.
plLength [in, out]: A reference to the length of the text range in the pNodesToSearch portion of the recognized string.
ppContextNodes [out]: A pointer to the IContextNode objects that are relevant to the specified text range for the specified context nodes.
pNodesToSearch [in]: The IContextNode objects to which to limit the search.

Return value

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

Remarks

The specified text range should be relative to the pNodesToSearch portion of the recognized string of the IInkAnalyzer, rather than to the recognized string of the entire IInkAnalyzer.

This method modifies the values of the plStart and plLength parameters by expanding the text range to the nearest word boundaries.

For example, if the recognized string is "I am late" and you call this method using the parameter values of 6 for plStart and 1 for plLength, which corresponds to the letter "a" in "late", this method returns a collection containing a single IContextNode, the InkWord or TextWord that corresponds to the word "late". For this example, this method also modifies the value of plStart to 5 and the value of plLength to 4, which corresponds to the word "late".

Note

The plStart parameter is relative to the recognized string of the pNodesToSearch parameter.

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