| Microsoft DirectX 8.1 (C++) |
This topic applies to Windows XP Home Edition and Windows XP Professional only.
The Remove method removes the specified ChannelLineup object from the collection.
Syntax
HRESULT Remove(
VARIANT varIndex
);
Parameters
varIndex
[in] Specifies the ChannelLineup object to be removed. The value in the vt member of the VARIANT structure must be one of the following.
| Value | Description |
| VT_UNKNOWN | The ppunkVal member contains an IUnknown interface pointer to the object to be removed. |
| VT_DISPATCH | The ppdispVal member contains an IDispatch interface pointer to the object to be removed. |
| VT_I4 | The lVal member contains the index of the object to be removed. This index value must be in the range from 0 to IChannelLineups::get_Count minus 1. |
Return Values
The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.
| Return code | Description |
| S_OK | The method succeeded. |
| E_INVALIDARG | varIndex is not a valid VARIANT subtype, or does not specify an existing object. |
Remarks
Removed objects are permanently deleted from the repository.
See Also