CArrayVar< TAny > Class Template Reference

template <>
class CArrayVar< TAny > : public CArrayVarBase

A template specialisation base class for variable length arrays.

The array buffer organisation is defined at construction.

The class is useful for constructing an array of variable length buffers, where the length is decided at run time.

This class is also useful as a data member of a base class in a thin template class/base class pair, where the type of the array element is not known until the owning thin template class is instantiated.

Inherits from

Constructor & Destructor Documentation

CArrayVar(TBufRep, TInt)

CArrayVar ( TBufRep aRep,
TInt aGranularity
) [inline]

Constructs a variable array with the specified granularity and buffer organization.

Note that no memory is allocated to the array buffer by this constructor.

panic
E32USER-CBase 19, if aGranularity is not positive.

Parameters

TBufRep aRep A pointer to a function used to expand the array buffer. The organisation of the array buffer is implied by the choice of this function. For a flat array buffer, pass (TBufRep)CBufFlat::NewL. For a segmented array buffer, pass (TBufRep)CBufSeg::NewL.
TInt aGranularity The granularity of the array.

Member Functions Documentation

AppendL(const TAny *, TInt)

void AppendL ( const TAny * aPtr,
TInt aLength
) [inline]

Appends an untyped element of specified length onto the end of the array.

Parameters

const TAny * aPtr A pointer to an untyped element to be appended.
TInt aLength The length of the untyped element.

At(TInt)

const TAny * At ( TInt anIndex ) const [inline]

Returns a pointer to the untyped element located at the specified position within the array.

The compiler uses this variant of the function if the returned pointer is used in an expression where it cannot be modified.

panic
E32USER-CBase 21, if anIndex is negative or greater than or equal to the number of objects currently within the array.

Parameters

TInt anIndex The position of the element within the array, relative to zero; i.e. zero implies the first element.

At(TInt)

TAny * At ( TInt anIndex ) [inline]

Returns a pointer to the untyped element located at the specified position within the array.

The compiler uses this variant of the function if the returned pointer is used in an expression where it can be modified.

panic
E32USER-CBase 21, if anIndex is negative or greater than or equal to the number of objects currently within the array.

Parameters

TInt anIndex The position of the element within the array, relative to zero; i.e. zero implies the first element.

ExtendL(TInt)

TAny * ExtendL ( TInt aLength ) [inline]

Extends the array by one element of specified length at the end of the array, i.e. at position CArrayVarBase::Count() , and returns a pointer to the new element location.

As elements are untyped, no construction is possible and the content of the new location remains undefined.

Note that the function always attempts to allocate a cell to contain the new element and may also attempt to expand the array buffer. If there is insufficient memory available, the function leaves. The leave code is one of the system wide error codes. If the function leaves, the array is left in the state it was in before the call.

Parameters

TInt aLength The length of the new element.