#include <app/cntdb.h>
| class TContactIter |
| Public Member Functions | |
|---|---|
| TContactIter(CContactDatabase &) | |
| IMPORT_C TContactItemId | FirstL() |
| IMPORT_C void | GotoL(TContactItemId) |
| IMPORT_C TContactItemId | LastL() |
| IMPORT_C TContactItemId | NextL() |
| IMPORT_C TContactItemId | PreviousL() |
| IMPORT_C void | Reset() |
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.
| IMPORT_C | TContactIter | ( | CContactDatabase & | aDatabase | ) |
Constructs the object with a contact database.
| Parameter | Description |
|---|---|
| aDatabase | The contact database over which to iterate. |
| IMPORT_C TContactItemId | FirstL | ( | ) |
Moves to the first contact item in the database.
Returns: The ID of the first contact item.
| IMPORT_C void | GotoL | ( | TContactItemId | aContactId | ) |
Moves to the specified contact item.
| Parameter | Description |
|---|---|
| aContactId | A contact item ID. Must not have a value of KNullContactId, or the function raises a panic. |
| IMPORT_C TContactItemId | LastL | ( | ) |
Moves to the last contact item in the database.
Returns: The ID of the last contact item.
| IMPORT_C TContactItemId | NextL | ( | ) |
Moves to the next contact item in the database.
On a newly initialised TContactIter, this function moves to the first item.
Returns: The ID of the next contact item. Has a value of KNullContactId if there are no more items.
| IMPORT_C TContactItemId | PreviousL | ( | ) |
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.
Returns: The ID of the previous contact item. Has a value of KNullContactId if there is no previous item.
| IMPORT_C void | Reset | ( | ) |
Resets the iterator to its initialised state, so that a subsequent call to NextL() goes to the first item.