ICATolls::Remove

Microsoft DirectX 8.1 (C++)

This topic applies to Windows XP Home Edition and Windows XP Professional only.

The Remove method removes a toll from the collection.

Syntax

HRESULT Remove(
  VARIANT  Index
);

Parameters

Index

[in] VARIANT that specifies the toll to remove. See Remarks for more information.

Return Values

Returns an HRESULT value. Possible values include the following.

Return code	Description
S_FALSE	The item was not found.
S_OK	Success.
CO_E_CLASSSTRING	The CLSID string is not formatted correctly.
E_FAIL	Index out of range.
REGDB_E_WRTIEGDB	The CLSID was not found.

Remarks

The Index parameter supports the following VARIANT types:

VT_I4: A zero-based index into the collection. The valid range is from 0 to ICATolls::get_Count() - 1.
VT_UNKNOWN or VT_DISPATCH: Pointer to the IUnknown or IDispatch interface of the toll.
VT_BSTR: A string that specifies the class identifier (CLSID) of the toll object, in the form {00000000-0000-0000-0000-000000000000}. The method uses the CLSIDFromString function to convert the string. It finds the first object in the collection with a matching CLSID, as determined from the IPersist::GetClassID method.

See Also