![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
CBase |
Abstract: CBase behaviour |
etelbgsm.h
gsmbas.lib
This class stores the results of phone book searches see RGsmPhoneBook::SearchLC() and CGsmPhoneBookSearch::SearchResults().
In both cases, instances of this class are created by the respective function. In the asynchronous variant the results are owned by the CGsmPhoneBookSearch class. In the synchronous variant the results are placed on the clean-up stack, and are owned by the client.
This class is not intended for user derivation.
Clients should not call a constructor to create this object. Instances of this class are created by the functions used to initiate the search.
~CGsmPhoneBookResults();
The destructor frees all resources owned by the object, prior to its destruction.
TInt EnumerateEntries(TInt& aCount);
This function retrieves the number of entries in the results list e.g. the number of results that match the last search string.
TInt& aCount |
On return, contains the number of entries matching the search string. |
TInt |
An error code: see System error codes. |
TInt GetEntry(TInt aPosition,RGsmPhoneBook::TEntry& aEntry);
This function retrieves a specific phone book entry from the search results.
TInt aPosition |
The index of the entry to be returned. The index is from within the sub-set of entries which match the search string returned by the previous search not the number of a physical slot within the phone book. |
RGsmPhoneBook::TEntry& aEntry |
On return, contains the specified phone book entry. |
TInt |
An error code: see System error codes. |
TInt GetNextEntry(RGsmPhoneBook::TEntry& aEntry);
This function returns the next phone book entry, with respect to the results cursor, in a search result list.
RGsmPhoneBook::TEntry& aEntry |
On return, contains the next entry. |
TInt |
An error code: see System error codes. |
TInt GetPreviousEntry(RGsmPhoneBook::TEntry& aEntry);
This function returns the previous phone book entry, with respect to the results cursor, in a search result list.
RGsmPhoneBook::TEntry& aEntry |
On return, contains the previous entry. |
TInt |
An error code: see System error codes. |
void Reset();
This function resets all entries in the search list to zero.
Invalid phone book search results index. |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |