CContactIdArray Class Reference

class CContactIdArray : public CBase

Array of contact item IDs (TContactItemIds).

Instances of this class are used in several contact database functions, for instance CContactDatabase::DeleteContactsL() .

Inherits from

Constructor & Destructor Documentation

CContactIdArray()

CContactIdArray ( ) [private]

~CContactIdArray()

IMPORT_C ~CContactIdArray ( )

The destructor frees all resources owned by the array, prior to its destruction.

Member Functions Documentation

AddL(TContactItemId)

IMPORT_C void AddL ( TContactItemId aId )

Appends a contact ID to the array.

Parameters

TContactItemId aId The contact ID to append to the array.

CloneL(const CContactIdArray *)

void CloneL ( const CContactIdArray * aArray ) [private]

Parameters

const CContactIdArray * aArray

ConstructL()

void ConstructL ( ) [private]

Count()

TInt Count ( ) const [inline]

Gets the number of contact IDs in the array.

ExternalizeL(RWriteStream &)

IMPORT_C void ExternalizeL ( RWriteStream & aStream ) const

Externalises a CContactIdArray object to a write stream. The presence of this function means that the standard templated operator<<() (defined in s32strm.h) is available to externalise objects of this class.

Parameters

RWriteStream & aStream Stream to which the object should be externalised.

Find(TContactItemId)

IMPORT_C TInt Find ( TContactItemId aId ) const

Finds the index of the specified contact ID within the array.

Parameters

TContactItemId aId The contact ID to find.

InsertL(TInt, TContactItemId)

void InsertL ( TInt aIndex,
TContactItemId aId
) [inline]

Inserts a contact ID into the array.

The index must be valid or a panic occurs.

The function may attempt to expand the array buffer. If there is insufficient memory available, the function leaves. The leave code is one of the system error codes. If the function leaves, the array is left in the state it was in before the call.

Parameters

TInt aIndex The index at which to insert the contact ID.
TContactItemId aId The contact ID to insert.

InternalizeL(RReadStream &)

IMPORT_C void InternalizeL ( RReadStream & aStream )

Internalises a CContactIdArray object from a read stream. The presence of this function means that the standard templated operator>>() (defined in s32strm.h) is available to internalise objects of this class.

Parameters

RReadStream & aStream Stream from which the object should be internalised.

MoveL(TInt, TInt)

IMPORT_C void MoveL ( TInt aOldIndex,
TInt aNewIndex
)

Moves a contact ID within the array.

Note: both indexes must be valid or a panic occurs.

Parameters

TInt aOldIndex The index of the ID to move.
TInt aNewIndex The new index for the contact ID.

NewL()

IMPORT_C CContactIdArray * NewL ( ) [static]

Allocates and constructs a new contact ID array.

NewL(const CContactIdArray *)

IMPORT_C CContactIdArray * NewL ( const CContactIdArray * aArray ) [static]

Allocates and constructs a new contact ID array and then copies the contents of aArray into it.

Parameters

const CContactIdArray * aArray Pointer to the contact ID array to copy.

NewLC()

IMPORT_C CContactIdArray * NewLC ( ) [static]

Allocates and constructs a new contact ID array.

The pointer to the object is left on the cleanup stack.

NewLC(const CContactIdArray *)

IMPORT_C CContactIdArray * NewLC ( const CContactIdArray * aArray ) [static]

Allocates and constructs a new contact ID array and then copies the contents of aArray into it.

The pointer to the object is left on the cleanup stack.

Parameters

const CContactIdArray * aArray Pointer to the contact ID array to copy.

NewLC(RReadStream &)

CContactIdArray * NewLC ( RReadStream & aStream ) [static]

Allocates and constructs a new contact ID array based on a RReadStream .

The pointer to the object is left on the cleanup stack.

Parameters

RReadStream & aStream RReadStream containing object to internalize.

Remove(TInt)

void Remove ( TInt aIndex ) [inline]

Removes the indexed contact ID from the array.

The index value must not be negative and must not be greater than the number of elements in the array, otherwise the function raises a panic.

Parameters

TInt aIndex The index of the contact ID to remove.

Remove(TInt, TInt)

void Remove ( TInt aIndex,
TInt aCount
) [inline]

Removes a block of contact IDs from the array.

This function raises a panic if any of the following are true:-

  • aCount is negative

  • aIndex is negative or is greater than the number of elements currently in the array

  • the sum of aIndex and aCount is greater than the number of elements currently in the array

Parameters

TInt aIndex The index of the first contact ID to remove.
TInt aCount The number of contiguous contact IDs to delete from the array. If this is not specified, a value of one is assumed.

Reset()

void Reset ( ) [inline]

Removes all contact IDs from the array.

ReverseOrder()

IMPORT_C void ReverseOrder ( )

Reverses the order of the whole array.

Sort()

void Sort ( )

operator[](TInt)

const TContactItemId & operator[] ( TInt aIndex ) const [inline]

Gets the indexed TContactItemId.

Parameters

TInt aIndex The position of the contact ID within the array, relative to zero. This must be non-negative and less than the number of objects in the array otherwise the operator raises a panic.

operator[](TInt)

TContactItemId & operator[] ( TInt aIndex ) [inline]

Gets the indexed TContactItemId.

Parameters

TInt aIndex The position of the contact ID within the array, relative to zero. This must be non-negative and less than the number of objects in the array otherwise the operator raises a panic.

Member Data Documentation

CArrayFixFlat< TContactItemId > * iIds

CArrayFixFlat < TContactItemId > * iIds [private]