class CRetrieveMobilePhoneENList : public CAsyncRetrieveStoreList |
Reads Emergency Number list from the phone or SIM store.
Instead of reading each emergency number entry individually, a client may be able to retrieve all the numbers in one go from SIM and/or NAM.
This functionality will be available if the TSY supports reading all entries in one go. The emergency number store's capabilities are returned within the iCaps field of RMobilePhoneStore::TMobilePhoneStoreInfoV1 and this will inform a client what type(s) of storage access the TSY supports.
When all entries in SIM and/or NAM are read in one go, a CMobilePhoneENList object will be returned to the client. The CMobilePhoneENList object that is returned to the client will contain the SIM and/or NAM entries and the client is able to use the function members of CMobilePhoneENList to enumerate and read the entries.
Due to the probable time taken to retrieve a list, clients must use an asynchronous approach based around the use of this object.
Public Member Functions | |
---|---|
~CRetrieveMobilePhoneENList() | |
IMPORT_C CRetrieveMobilePhoneENList * | NewL(RMobilePhoneStore &) |
IMPORT_C CMobilePhoneENList * | RetrieveListL() |
IMPORT_C void | Start(TRequestStatus &) |
Protected Member Functions | |
---|---|
CRetrieveMobilePhoneENList(RMobilePhoneStore &) | |
void | ConstructL() |
void | RestoreListL() |
Inherited Enumerations | |
---|---|
CActive:TPriority | |
CAsyncRetrieveVariableLengthBufferV2:@151 |
Private Attributes | |
---|---|
CMobilePhoneENList * | iResults |
CRetrieveMobilePhoneENList | ( | RMobilePhoneStore & | aStore | ) | [protected] |
RMobilePhoneStore & aStore |
IMPORT_C | ~CRetrieveMobilePhoneENList | ( | ) |
The destructor frees all resources owned by the object, prior to its destruction.
IMPORT_C CRetrieveMobilePhoneENList * | NewL | ( | RMobilePhoneStore & | aStore | ) | [static] |
This function member creates an instance of the CActive derived CRetrieveMobilePhoneENList class.
RMobilePhoneStore & aStore | An instance of RMobileENStore as it this store that the list retrieval class will operate on. |
void | RestoreListL | ( | ) | [protected, virtual] |
This method restores a list from a buffer that contains the streamed version of the list
IMPORT_C CMobilePhoneENList * | RetrieveListL | ( | ) |
This function member provides the client with a handle to the list class retrieved from the store. The client will call this function member once Start() has completed.
When the client calls this function member the ownership of the CMobilePhoneENList object will transfer to the client, so the client is then responsible for eventual deletion of this object.
IMPORT_C void | Start | ( | TRequestStatus & | aReqStatus | ) |
This function member starts the two-phase retrieval of all emergency numbers.
TRequestStatus & aReqStatus | On completion, the status of the request; KErrNone if successful, KErrNotSupported if the phone does not support access to an emergency number store and KErrNotFound if the store does not exist. If the list is empty then KErrNone is returned. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.