IInkCustomStrokes::Remove
4/8/2010
Removes the IInkStrokes collection from the IInkCustomStrokes collection.
Syntax
HRESULT Remove (
VARIANT Identifier
);
Parameters
Identifier
[in] The name or index of the collection of strokes to remove from the collection of custom strokes.For more information about the VARIANT structure, see Using the Automation Library with Windows Mobile Ink.
Return Value
| HRESULT value | Description |
|---|---|
S_OK |
Success. |
E_POINTER |
A parameter contained an invalid pointer |
E_OUTOFMEMORY |
Cannot allocate memory to complete the operation |
E_INK_EXCEPTION |
An exception occurred inside the method |
E_INK_INCOMPATIBLE_OBJECT |
Invalid input parameter |
E_INK_MISMATCHED_INK_OBJECT |
The InkDisp object of the InkStrokes collection and the IInkStrokeDisp object don't match |
E_FAIL |
An unspecified error occurred |
DISP_E_TYPEMISMATCH |
An invalid variant was passed in |
Remarks
IInkCustomStrokes 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 of the IInkDisp object.
The Identifier parameter can be either a BSTR or a long. Use a BSTR for the name originally given to the custom stroke when it was added to the collection, and use a long for the index of the custom stroke in the collection. To specify the name of the custom stroke when you are using late binding, you must pass in the argument as a string literal and not use a variable (script).
For more information about the BSTR data type, see Using the Automation Library with Windows Mobile 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 |