IInkStrokes::Remove
4/8/2010
Removes an IInkStrokeDisp object from an IInkStrokes collection.
Syntax
HRESULT Remove (
[in] IInkStrokeDisp *stroke
);
Parameters
- stroke
The IInkStrokeDisp to remove.
Return Value
| HRESULT value | 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 IInkDisp object. |
E_INK_MISMATCHED_INK_OBJECT |
The IInkDisp object of the IInkStrokes collection and this IInkStrokeDisp object do not match. |
E_UNEXPECTED |
Unexpected parameter or property type. |
Remarks
IInkStrokes 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 IInkDisp::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
| 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 |