Share via

_XRValueCollectionBaseT.GetIsReadOnly(bool *) (Compact 2013)

  • Article

3/28/2014

This method indicates whether you can add, remove, or modify XRValue objects in the collection.

Syntax

HRESULT STDMETHODCALLTYPE GetIsReadOnly(
bool * pIsReadOnly)

Parameters

  • pIsReadOnly
    [out] A Boolean value that is false if you can add, remove, or modify XRValue objects in the collection. Otherwise, pIsReadOnly is true.

Return Value

The following table shows the possible return values.

Value

Description

S_OK

The method succeeded.

E_POINTER

The pIsReadOnly parameter is not valid.

Remarks

By default, _XRValueCollectionBaseT.GetIsReadOnly always returns false.

An application can call GetIsReadOnly on a derived class to test whether a collection is read-only. To implement a derived collection class whose items applications cannot update, you can override methods such as _XRValueCollectionBaseT.Add(XRValue *) and _XRValueCollectionBaseT.Remove(XRValue *) to always return S_FALSE, and override the GetIsReadOnly method to return true.

Requirements

Header

XRCollection.h

See Also

Reference

_XRValueCollectionBaseT<IFace,ItemType,ItemComparer,ItemConverter,ItemLifeManager>
_XRValueCollectionBaseT.Clear
_XRValueCollectionBaseT.RemoveAt(int)
_XRValueCollectionBaseT.Insert(int,XRValue *)