IInkDisp::DeleteStrokes method (msinkaut.h)

Article
02/22/2024

Deletes an InkStrokes collection from the Strokes collection of the InkDisp object.

Syntax

HRESULT DeleteStrokes(
  [in, optional] IInkStrokes *Strokes
);

Parameters

[in, optional] Strokes

Optional. Specifies the collection of strokes to delete from the InkDisp object. The default value is NULL.

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 memory that is used to perform the operation.
E_FAIL	An unspecified error occurred.
E_INK_MISMATCHED_INK_OBJECT	The InkDisp object of the strokes must match the known InkDisp object.
E_INK_EXCEPTION	An exception occurred inside the method.
E_UNEXPECTED	Unexpected parameter or property type.

Remarks

This method deletes all of the strokes in the InkDisp object if no InkStrokes collection is passed in. To delete only one stroke at a time, call the DeleteStroke method.

The InkDisp object renumbers the indices of the remaining strokes in the InkDisp object if the strokes that were deleted do not fall at the end of the InkDisp object's collection of strokes.

Note The contents of a InkStrokes collection become invalid when strokes that are contained in the collection are deleted from the InkDisp object.

DeleteStrokes can result in an error if called while the user is actively laying down ink.

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