#include <app/CPbkContactIter.h>
| class CPbkContactIter : public CBase |
| Public Attributes | |
|---|---|
| __DECLARE_TEST | |
| Public Member Functions | |
|---|---|
| ~CPbkContactIter() | |
| IMPORT_C CPbkContactItem * | CurrentL() |
| IMPORT_C TContactItemId | FirstL() |
| IMPORT_C CPbkContactItem * | GetCurrentL() |
| IMPORT_C CPbkContactIter * | NewL(CPbkContactEngine &, TBool) |
| IMPORT_C CPbkContactIter * | NewLC(CPbkContactEngine &, TBool) |
| IMPORT_C TContactItemId | NextL() |
| IMPORT_C void | Reset() |
Phonebook contact iterator. Only iterates through recognised Phonebook contact cards, not groups or templates. NextL jumps over any other contacts.
| IMPORT_C CPbkContactItem * | CurrentL | ( | ) | const |
Returns the current Phonebook contact, NULL if none.
Returns: The contact item the iterator is currently pointing at.
| IMPORT_C TContactItemId | FirstL | ( | ) |
Intializes the iterator to the first Phonebook contact.
Returns: Id of the first Phonebook contact, KNullContactId if none found.
| IMPORT_C CPbkContactItem * | GetCurrentL | ( | ) | const |
Returns the current Phonebook contact, NULL if none. Caller is responsible for deleting the contact, thus ownership of the contact item is passed to the client.
Returns: The contact item the iterator is currently pointing at.
| IMPORT_C CPbkContactIter * | NewL | ( | CPbkContactEngine & | aEngine, |
| TBool | aUseMinimalRead = EFalse | |||
| ) | [static] | |||
Creates a new instace of this class.
| Parameter | Description |
|---|---|
| aEngine | Phonebook engine whose contacts to iterate. |
| aUseMinimalRead | Use ReadMinimalContactL instead of ReadContactL to read the contacts. |
Returns: Contact iterator instance.
| IMPORT_C CPbkContactIter * | NewLC | ( | CPbkContactEngine & | aEngine, |
| TBool | aUseMinimalRead = EFalse | |||
| ) | [static] | |||
Same as NewL but leaves the created object on the cleanup stack. Creates a new instace of this class.
| Parameter | Description |
|---|---|
| aEngine | Phonebook engine whose contacts to iterate. |
| aUseMinimalRead | Use ReadMinimalContactL instead of ReadContactL to read the contacts. |
Returns: Contact iterator instance.
| IMPORT_C TContactItemId | NextL | ( | ) |
Advances the iterator to the next Phonebook contact.
Returns: Id of the next Phonebook contact, KNullContactId if none found.