Share via

_XRValueCollectionBaseT.Remove(XRValue *) (Compact 7)

  • Article

3/12/2014

This method removes the specified XRValue object from the collection.

Syntax

HRESULT STDMETHODCALLTYPE Remove(
XRValue * pValue)

Parameters

  • pValue
    [in] Pointer to the XRValue object to remove from the collection.

Return Value

The following table shows the possible return values.

Value Description

S_OK

The method succeeded.

E_FAIL

The method was not successful.

E_POINTER

The pValue parameter is not valid.

E_NOTFOUND

The object in pValue is not equal to an object in the collection.

Remarks

The Remove method iterates through the collection and uses _ItemComparer.AreObjectsEqual(const Type&,const Type&) to locate and remove the specified XRValue object.

This method updates the current version of the collection, which is stored in m_nVersion.

Requirements

Header

XRCollection.h

See Also

Reference

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