Symbian^3 Application Developer Library >

CRetrieveMobilePhoneNamList Class Reference

class CRetrieveMobilePhoneNamList : public CAsyncRetrieveStoreList

The phone's NAM store.

Instead of reading each NAM entry individually, a client may be able to retrieve all the parameters in one NAM in one go.

This functionality will be available if the TSY supports reading all entries in one NAM. The NAM storage 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 one NAM are read in one go, a CMobilePhoneNamList 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.

Inherits from

Nested Classes and Structures

Public Member Functions
~CRetrieveMobilePhoneNamList ()
IMPORT_C CRetrieveMobilePhoneNamList * NewL ( RMobilePhoneStore &)
IMPORT_C CMobilePhoneNamList * RetrieveListL ()
IMPORT_C CMobilePhoneNamListV4 * RetrieveListV4L ()
IMPORT_C void Start ( TRequestStatus &, TInt )
IMPORT_C void StartV4 ( TRequestStatus &, TInt )
Protected Member Functions
CRetrieveMobilePhoneNamList ( RMobilePhoneStore &)
void ConstructL ()
void RestoreListL ()
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::Start(TRequestStatus &)
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
TInt iListExtensionId
TPckgBuf < TNamRequestData > iRequestData
CMobilePhoneNamList * iResults
CMobilePhoneNamListV4 * iResultsV4
Inherited Attributes
CActive::iStatus
CAsyncRetrieveStoreList::iStore
CAsyncRetrieveVariableLengthBufferV2::iIpcCancel
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase1
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase2
CAsyncRetrieveVariableLengthBufferV2::iResultsBuf
CAsyncRetrieveVariableLengthBufferV2::iResultsPtr
CAsyncRetrieveVariableLengthBufferV2::iState
CAsyncRetrieveWithClientIds::iId

Constructor & Destructor Documentation

CRetrieveMobilePhoneNamList(RMobilePhoneStore &)

CRetrieveMobilePhoneNamList ( RMobilePhoneStore & aStore ) [protected]

Parameters

RMobilePhoneStore & aStore

~CRetrieveMobilePhoneNamList()

IMPORT_C ~CRetrieveMobilePhoneNamList ( )

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

Member Functions Documentation

ConstructL()

void ConstructL ( ) [protected]

NewL(RMobilePhoneStore &)

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

This member function member creates an instance of the CRetrieveMobilePhoneNamList class.

capability
None

Parameters

RMobilePhoneStore & aStore An instance of RMobileNamStore as it is this store that the list retrieval class will operate on.

RestoreListL()

void RestoreListL ( ) [protected, virtual]

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

RetrieveListL()

IMPORT_C CMobilePhoneNamList * 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 CMobilePhoneNamList 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
ReadDeviceData

RetrieveListV4L()

IMPORT_C CMobilePhoneNamListV4 * RetrieveListV4L ( )

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 CMobilePhoneNamListV4 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
ReadDeviceData

Start(TRequestStatus &, TInt)

IMPORT_C void Start ( TRequestStatus & aReqStatus,
TInt aNamId
)

This function member starts the two-phase list retrieval.

capability
ReadDeviceData

Parameters

TRequestStatus & aReqStatus On completion, the status of the request; KErrNone if successful, KErrNotSupported if the phone does not support access to an NAM list store and KErrNotFound if the store does not exist. If the list is empty then KErrNone is returned.
TInt aNamId The identity of the NAM that the client wishes to read.

StartV4(TRequestStatus &, TInt)

IMPORT_C void StartV4 ( TRequestStatus & aReqStatus,
TInt aNamId
)

This function member starts the two-phase list retrieval.

capability
ReadDeviceData

Parameters

TRequestStatus & aReqStatus On completion, the status of the request; KErrNone if successful, KErrNotSupported if the phone does not support access to an NAM list store and KErrNotFound if the store does not exist. If the list is empty then KErrNone is returned.
TInt aNamId The identity of the NAM that the client wishes to read.

Member Data Documentation

TInt iListExtensionId

TInt iListExtensionId [private]

TPckgBuf< TNamRequestData > iRequestData

TPckgBuf < TNamRequestData > iRequestData [private]

CMobilePhoneNamList * iResults

CMobilePhoneNamList * iResults [private]

CMobilePhoneNamListV4 * iResultsV4

CMobilePhoneNamListV4 * iResultsV4 [private]

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.