Share via

_XRValueCollectionBaseT.RemoveItemImpl(int) (Compact 2013)

  • Article

3/28/2014

This protected method implements collection operations that remove items from the collection.

Note

This method is reserved. In a derived class, call _XRValueCollectionBaseT.Remove(XRValue *) instead of calling RemoveItemImpl.

Syntax

HRESULT STDMETHODCALLTYPE RemoveItemImpl(
int nIndex)

Parameters

  • nIndex
    [in] Index of the XRValue object in the collection to remove.

Return Value

The following table shows the possible return values.

Value

Description

S_OK

The method succeeded.

E_INVALIDARG

The index location is not valid.

Remarks

You can override the RemoveItemImpl method in a derived class.

To remove an object from the _XRValueCollectionBaseT<IFace,ItemType,ItemComparer,ItemConverter,ItemLifeManager> collection, call the _XRValueCollectionBaseT.Remove(XRValue *) method, which invokes RemoveItemImpl.

The implementation of _XRValueCollectionBaseT::RemoveItemImpl calls _ItemLifeManager.ReleaseItem(Obj *) to release references to the object that it removed from the collection.

Requirements

Header

XRCollection.h

See Also

Reference

_XRValueCollectionBaseT<IFace,ItemType,ItemComparer,ItemConverter,ItemLifeManager>