CRetrieveMobilePhoneENList Class Reference

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 voidStart(TRequestStatus &)
Protected Member Functions
CRetrieveMobilePhoneENList(RMobilePhoneStore &)
voidConstructL()
voidRestoreListL()
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::Extension_(TUint,TAny *&,TAny *)
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CAsyncRetrieveStoreList::CAsyncRetrieveStoreList(RMobilePhoneStore &)
CAsyncRetrieveStoreList::CancelReq(TInt,TInt)
CAsyncRetrieveStoreList::Get(TInt,TRequestStatus &,TDes8 &,TDes8 &)
CAsyncRetrieveStoreList::~CAsyncRetrieveStoreList()
CAsyncRetrieveVariableLengthBufferV2::CAsyncRetrieveVariableLengthBufferV2()
CAsyncRetrieveVariableLengthBufferV2::CompleteIfInUse(TRequestStatus &)
CAsyncRetrieveVariableLengthBufferV2::FreeBuffer()
CAsyncRetrieveVariableLengthBufferV2::Start(TRequestStatus &,TDes8 *,TDes8 *)
CAsyncRetrieveVariableLengthBufferV2::~CAsyncRetrieveVariableLengthBufferV2()
CAsyncRetrieveWithClientIds::CAsyncRetrieveWithClientIds(TInt,TInt)
CBase::CBase()
CBase::Delete(CBase *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Inherited Enumerations
CActive:TPriority
CAsyncRetrieveVariableLengthBufferV2:@151
Private Attributes
CMobilePhoneENList *iResults
Inherited Attributes
CActive::iStatus
CAsyncRetrieveStoreList::iStore
CAsyncRetrieveVariableLengthBufferV2::iIpcCancel
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase1
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase2
CAsyncRetrieveVariableLengthBufferV2::iResultsBuf
CAsyncRetrieveVariableLengthBufferV2::iResultsPtr
CAsyncRetrieveVariableLengthBufferV2::iState
CAsyncRetrieveWithClientIds::iId

Constructor & Destructor Documentation

CRetrieveMobilePhoneENList(RMobilePhoneStore &)

CRetrieveMobilePhoneENList(RMobilePhoneStore &aStore)[protected]

Parameters

RMobilePhoneStore & aStore

~CRetrieveMobilePhoneENList()

IMPORT_C~CRetrieveMobilePhoneENList()

The destructor frees all resources owned by the object, prior to its destruction.

Member Functions Documentation

ConstructL()

voidConstructL()[protected]

NewL(RMobilePhoneStore &)

IMPORT_C CRetrieveMobilePhoneENList *NewL(RMobilePhoneStore &aStore)[static]

This function member creates an instance of the CActive derived CRetrieveMobilePhoneENList class.

capability
None

Parameters

RMobilePhoneStore & aStoreAn instance of RMobileENStore as it this store that the list retrieval class will operate on.

RestoreListL()

voidRestoreListL()[protected, virtual]

This method restores a list from a buffer that contains the streamed version of the list

RetrieveListL()

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.

leave
KErrNotFound if there is no valid list object to return to the client.
capability
ReadUserData

Start(TRequestStatus &)

IMPORT_C voidStart(TRequestStatus &aReqStatus)

This function member starts the two-phase retrieval of all emergency numbers.

capability
ReadUserData

Parameters

TRequestStatus & aReqStatusOn 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.

Member Data Documentation

CMobilePhoneENList * iResults

CMobilePhoneENList *iResults[private]