IInkExtendedProperties::Remove
4/8/2010
Removes the IInkExtendedProperty object from the IInkExtendedProperties collection.
Syntax
HRESULT Remove (
[in] VARIANT Identifier
);
Parameters
Identifier
[in] The identifier of the IInkExtendedProperty object to remove from the collection. The identifier can be a globally unique identifier (GUID), an index, or an extended property object.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. |
CO_E_CLASSSTRING |
Invalid GUID format. |
TPC_E_INVALID_PROPERTY |
Property could not be found (invalid GUID or index). |
E_INK_EXCEPTION |
An exception occurred inside the method. |
E_FAIL |
An unspecified error occurred. |
E_INVALIDARG |
Invalid display handle. |
E_UNEXPECTED |
Unexpected parameter or property type. |
Remarks
This method removes only the extended property from a snapshot of, or reference to, the ink data and does not remove the actual ink data.
The Identifier parameter can be a BSTR, a LONG, or an IDispatch. Use a BSTR for the GUID of the property, a LONG for the index of the property, and an IDispatch for a reference to a specific property. To specify the GUID of the property when you are using late binding, such as when you dimension a variable as type OBJECT in Visual Basic 6.0 or when you use a scripting language, you must either dimension the argument variable as a STRING (Visual Basic 6.0), or 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 |