Class TContactIter

class TContactIter;

Description

Iterates through the sorted contact items in a contact database.

A value of KNullContactId is returned by the iterator if a requested item cannot be found.

Members

Defined in TContactIter:

• FirstL()Moves to the first contact item in the database
• GotoL()Moves to the specified contact item
• LastL()Moves to the last contact item in the database
• NextL()Moves to the next contact item in the database
• PreviousL()Moves to the previous contact item in the database
• Reset()Resets the iterator to its initialised state, so that a subsequent call to NextL() goes to the first item
• TContactIter()Constructs the object with a contact database

IMPORT_C TContactIter(CContactDatabase &aDatabase);

Description

Constructs the object with a contact database.

Parameters

IMPORT_C TContactItemId FirstL();

Description

Moves to the first contact item in the database.

Return value

IMPORT_C TContactItemId NextL();

Description

Moves to the next contact item in the database.

On a newly initialised TContactIter, this function moves to the first item.

Return value

IMPORT_C TContactItemId PreviousL();

Description

Moves to the previous contact item in the database.

Note: you must not call this function on a newly initialised database, otherwise the function raises a panic.

Return value

IMPORT_C TContactItemId LastL();

Description

Moves to the last contact item in the database.

Return value

IMPORT_C void GotoL(TContactItemId aContactId);

Description

Moves to the specified contact item.

Parameters

IMPORT_C void Reset();

Description

Resets the iterator to its initialised state, so that a subsequent call to NextL() goes to the first item.