Class CArrayVarBase

CArrayVarBase

Support

Supported from 5.0

Description

An implementation base class for variable length arrays. It provides implementation and public functions which are common to all variable length type arrays.

The class is always derived from and is never instantiated explicitly.

Derivation

CArrayVarBase An implementation base class for variable length arrays CBase Base class for all classes to be instantiated on the heap

Defined in CArrayVarBase:
Compress(), Count(), Delete(), Length(), Reset(), Sort(), ~CArrayVarBase()

Inherited from CBase:
operator new()

~CArrayVarBase();

Description

Frees all resources owned by the object, prior to its destruction.

TInt Count() const;

Description

Returns the number of elements held in the array.

Return value

TInt The number of array elements

TInt Length(TInt anIndex) const;

Description

Returns the length of a specific element.

Parameters

TInt anIndex The position of the element within the array. The position is relative to zero, (i.e. the first element in the array is at position 0). This value must not be negative and must not be greater than the number of elements currently in the array, otherwise the function raises an E32USER-CBase 21 panic.

Return value

TInt The length of the element at position anIndex.

void Reset();

Description

Deletes all elements from the array and frees the memory allocated to the array buffer.

As each element of a variable array is contained within its own heap cell, this function has the effect of freeing all such cells.

void Compress();

Description

Removes excess space from the array buffer. The effect is to reduce the memory allocated to the array buffer so that it is just sufficient to represent the array. This applies to both flat and segmented array buffers.

If the array is empty, then the memory allocated to the array buffer is freed.

TInt Sort(TKeyArrayVar &aKey);

Description

Sorts the elements of the array into key sequence.

Parameters

TKeyArrayVar& aKey The key object defining the properties of the key.

Return value

TInt KErrNone, if the sort completes successfully KErrGeneral, if the stack overflows

void Delete(TInt anIndex);
void Delete(TInt anIndexPos,TInt aCount);

Description

Removes one or more contiguous elements from the array, starting at a specific position.

Deleting elements from the array does not cause the array buffer to be automatically compressed. Call CArrayVarBase::Compress() to return excess space to the heap.

Notes

The sum of anIndex and aCount must not be greater than the number of elements currently in the array, otherwise the functions raise an E32USER-CBase 29 panic.

Parameters

TInt anIndex The position within the array from where deletion of elements is to start. The position is relative to zero, i.e. zero implies that elements, starting with the first, are deleted from the array. This value must not be negative and must not be greater than the number of elements currently in the array, otherwise the function raises an E32USER-CBase 21 panic. TInt aCount If specified, the number of elements to be deleted from the array. If this argument is not specified, a value of one is assumed. If specified, the value must not be negative otherwise the function raises an E32USER-CBase 25 panic.