| class CRetrieveMobilePhoneONList : public CAsyncRetrieveStoreList |
Reads Own Number list from the phone or SIM's Own Number store.
Instead of reading each own number entry individually, a client may be able to retrieve all the own numbers in one go.
This functionality will be available if the own number store's capabilities include KCapsWholeStore. These 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 for that store.
When all entries in own number store are read in one go, a CMobilePhoneONList object will be returned to the client.
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 | |
|---|---|
| ~CRetrieveMobilePhoneONList() | |
| IMPORT_C CRetrieveMobilePhoneONList * | NewL(RMobilePhoneStore &) |
| IMPORT_C CMobilePhoneONList * | RetrieveListL() |
| IMPORT_C void | Start(TRequestStatus &) |
| Protected Member Functions | |
|---|---|
| CRetrieveMobilePhoneONList(RMobilePhoneStore &) | |
| void | ConstructL() |
| void | RestoreListL() |
| Inherited Enumerations | |
|---|---|
| CActive:TPriority | |
| CAsyncRetrieveVariableLengthBufferV2:@151 | |
| Private Attributes | |
|---|---|
| CMobilePhoneONList * | iResults |
| CRetrieveMobilePhoneONList | ( | RMobilePhoneStore & | aStore | ) | [protected] |
| RMobilePhoneStore & aStore |
| IMPORT_C | ~CRetrieveMobilePhoneONList | ( | ) |
The destructor frees all resources owned by the object, prior to its destruction.
| IMPORT_C CRetrieveMobilePhoneONList * | NewL | ( | RMobilePhoneStore & | aStore | ) | [static] |
This function member creates an instance of the CActive derived CRetrieveMobilePhoneONList class.
| RMobilePhoneStore & aStore | An instance of RMobileONStore as 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 CMobilePhoneONList * | 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 CMobilePhoneONList 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 own numbers.
| TRequestStatus & aReqStatus | On completion, the status of the request; KErrNone if successful, KErrNotSupported if the phone does not support a access to an own 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.