IInkStrokes::Remove method (msinkaut.h)

Article
02/22/2024

Removes an IInkStrokeDisp object from a InkStrokes collection.

Syntax

HRESULT Remove(
  [in] IInkStrokeDisp *InkStroke
);

Parameters

[in] InkStroke

The IInkStrokeDisp to remove.

Return value

This method can return one of these values.

Return code	Description
S_OK	Success.
E_POINTER	A parameter contained an invalid pointer.
E_OUTOFMEMORY	Cannot allocate IInkStrokeDisp handler helper object.
E_INK_EXCEPTION	An exception occurred inside the method.
E_INK_INCOMPATIBLE_OBJECT	IInkStroke* does not point to a valid InkDisp Class object.
E_INK_MISMATCHED_INK_OBJECT	The InkDisp object of the InkStrokes collection and this IInkStrokeDisp object do not match.
E_UNEXPECTED	Unexpected parameter or property type.

Remarks

InkStrokes collections are sets of references to ink data and are not the actual data itself. This method removes only the collection of strokes from a snapshot of, or reference to, the data and does not remove the actual ink data. To delete the collection from the actual ink data, call the DeleteStrokes method.

After calling the Remove method, the strokes in the collection are reordered. For example, after calling Strokes.Remove(Strokes.Item(0)), what used to be Strokes.Item(1) is now Strokes.Item(0), what was Strokes.Item(2) is now Strokes.Item(1), and so forth.

Requirements

Requirement	Value
Minimum supported client	Windows XP Tablet PC Edition [desktop apps only]
Minimum supported server	None supported
Target Platform	Windows
Header	msinkaut.h
Library	InkObj.dll