IInkDisp::DeleteStrokes
4/8/2010
Deletes an IInkStrokes collection from the IInkDisp::Strokes collection of the IInkDisp object.
Syntax
HRESULT DeleteStrokes (
[in, optional, defaultvalue(0)] IInkStrokes* strokes
);
Parameters
- strokes
[in] Specifies the collection of strokes to delete from the IInkDisp object. The default value is NULL.
Return Value
- 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 IInkDisp object of the strokes must match the known IInkDisp 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 IInkDisp object if no IInkStrokes collection is passed in. To delete only one stroke at a time, call the IInkDisp::DeleteStroke method.
The IInkDisp object renumbers the indices of the remaining strokes in the IInkDisp object if the strokes that were deleted do not fall at the end of the IInkDisp object's collection of strokes.
Note
The contents of an IInkStrokes collection become invalid when strokes that are contained in the collection are deleted from the IInkDisp object.
DeleteStrokes can result in an error if called while the user is actively laying down ink.
Requirements
| Header | msinkaut.h |
| Windows Embedded CE | Windows CE 5.0 and later |
| Windows Mobile | Windows Mobile 6 Classic and later, Windows Mobile 6 Professional and later |