CRetrieveMobilePhoneCcbsList Class Reference

class CRetrieveMobilePhoneCcbsList : public CAsyncRetrievePhoneList

Retrieve a list of all active CCBS requests from the phone.

Each CCBS request will be represented by an entry in CMobilePhoneCcbsList. The client is able to use the member functions of this class to enumerate and read the CCBS request entries.

Due to the probable time taken to retrieve a list, clients must use an asynchronous approach based around the use of CRetrieveMobilePhoneCcbsList.

Public Member Functions
~CRetrieveMobilePhoneCcbsList()
IMPORT_C CRetrieveMobilePhoneCcbsList *NewL(RMobilePhone &)
IMPORT_C CMobilePhoneCcbsList *RetrieveListL()
IMPORT_C voidStart(TRequestStatus &)
Protected Member Functions
CRetrieveMobilePhoneCcbsList(RMobilePhone &)
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()
CAsyncRetrievePhoneList::CAsyncRetrievePhoneList(RMobilePhone &)
CAsyncRetrievePhoneList::CancelReq(TInt,TInt)
CAsyncRetrievePhoneList::Get(TInt,TRequestStatus &,TDes8 &,TDes8 &)
CAsyncRetrievePhoneList::~CAsyncRetrievePhoneList()
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
CMobilePhoneCcbsList *iResults
Inherited Attributes
CActive::iStatus
CAsyncRetrievePhoneList::iPhone
CAsyncRetrieveVariableLengthBufferV2::iIpcCancel
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase1
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase2
CAsyncRetrieveVariableLengthBufferV2::iResultsBuf
CAsyncRetrieveVariableLengthBufferV2::iResultsPtr
CAsyncRetrieveVariableLengthBufferV2::iState
CAsyncRetrieveWithClientIds::iId

Constructor & Destructor Documentation

CRetrieveMobilePhoneCcbsList(RMobilePhone &)

CRetrieveMobilePhoneCcbsList(RMobilePhone &aPhone)[protected]

Parameters

RMobilePhone & aPhone

~CRetrieveMobilePhoneCcbsList()

IMPORT_C~CRetrieveMobilePhoneCcbsList()

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

Member Functions Documentation

ConstructL()

voidConstructL()[protected]

NewL(RMobilePhone &)

IMPORT_C CRetrieveMobilePhoneCcbsList *NewL(RMobilePhone &aPhone)[static]

This member function creates an instance of the CRetrieveMobilePhoneCcbsList class.

capability
None

Parameters

RMobilePhone & aPhoneA reference to the RMobilePhone sub-session, as it is this sub-session 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 CMobilePhoneCcbsList *RetrieveListL()

This member function provides the client with a handle to the list class retrieved from the phone. The client will call this member function once Start() has completed.

When the client calls this member function the ownership of the CMobilePhoneCcbsList 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 &)

IMPORT_C voidStart(TRequestStatus &aReqStatus)

This member function starts the two-phase list retrieval.

capability
NetworkServices
capability
ReadDeviceData

Parameters

TRequestStatus & aReqStatusOn completion, the status of the request; KErrNone if successful, KErrNotSupported if the phone does not support access to a CCBS list store and KErrNotFound if the store does not exist. If the list is empty then KErrNone is returned.

Member Data Documentation

CMobilePhoneCcbsList * iResults

CMobilePhoneCcbsList *iResults[private]