IInkAnalyzer::RemoveStroke method

Article
01/07/2021

Removes the specified stroke from the IInkAnalyzer.

Syntax

HRESULT RemoveStroke(
  [in] LONG *plStrokeId
);

Parameters

plStrokeId [in]: The stroke identifier.

Return value

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

Remarks

This method removes the packet data for, and references to, the specified stroke from the IInkAnalyzer.

This method removes the stroke from the leaf context node that references the stroke. If the IContextNode no longer references any strokes, this method deletes the IContextNode and any ancestor IContextNode objects that no longer have any child nodes.

After this method removes the stroke from the IContextNode, it updates the IInkAnalyzer object's dirty region (see IInkAnalyzer::GetDirtyRegion Method) to include the bounding box of the removed stroke.

If plStrokeId does not identify a stroke associated with the IInkAnalyzer, this method returns without updating the ink analyzer.

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