CRetrieveMobilePhoneCWList Class Reference

class CRetrieveMobilePhoneCWList : public CAsyncRetrievePhoneList

Retrieves the Call Waiting status list from the phone.

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

Public Member Functions
~CRetrieveMobilePhoneCWList ()
IMPORT_C CRetrieveMobilePhoneCWList * NewL ( RMobilePhone &)
IMPORT_C CMobilePhoneCWList * RetrieveListL ()
IMPORT_C void Start ( TRequestStatus &, RMobilePhone::TMobileInfoLocation )
Protected Member Functions
CRetrieveMobilePhoneCWList ( RMobilePhone &)
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()
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
TPckgBuf < TGetCallWaitingRequest > iCWRequestData
CMobilePhoneCWList * iResults
Inherited Attributes
CActive::iStatus
CAsyncRetrievePhoneList::iPhone
CAsyncRetrieveVariableLengthBufferV2::iIpcCancel
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase1
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase2
CAsyncRetrieveVariableLengthBufferV2::iResultsBuf
CAsyncRetrieveVariableLengthBufferV2::iResultsPtr
CAsyncRetrieveVariableLengthBufferV2::iState
CAsyncRetrieveWithClientIds::iId

Constructor & Destructor Documentation

CRetrieveMobilePhoneCWList(RMobilePhone &)

CRetrieveMobilePhoneCWList ( RMobilePhone & aPhone ) [protected]

Parameters

RMobilePhone & aPhone

~CRetrieveMobilePhoneCWList()

IMPORT_C ~CRetrieveMobilePhoneCWList ( )

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

Member Functions Documentation

ConstructL()

void ConstructL ( ) [protected]

NewL(RMobilePhone &)

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

This function member creates an instance of the CRetrieveMobilePhoneCWList class.

capability
None

Parameters

RMobilePhone & aPhone A reference to the RMobilePhone sub-session as this is the sub-session 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 CMobilePhoneCWList * RetrieveListL ( )

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

When the client calls this function member the ownership of the CMobilePhoneCWList 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 &, RMobilePhone::TMobileInfoLocation)

IMPORT_C void Start ( TRequestStatus & aReqStatus,
RMobilePhone::TMobileInfoLocation aLocation = RMobilePhone::EInfoLocationCachePreferred
)

This function member starts the two-phase list retrieval.

capability
NetworkServices
capability
ReadDeviceData

Parameters

TRequestStatus & aReqStatus On completion, the status of the request; KErrNone if successful, KErrNotSupported if the phone does not support access to a call waiting list store and KErrNotFound if the store does not exist. If the list is empty then KErrNone is returned.
RMobilePhone::TMobileInfoLocation aLocation = RMobilePhone::EInfoLocationCachePreferred Specifies from where this information should be retrieved. Defaults to RMobilePhone::EInfoLocationCachePreferred

Member Data Documentation

TPckgBuf< TGetCallWaitingRequest > iCWRequestData

TPckgBuf < TGetCallWaitingRequest > iCWRequestData [private]

CMobilePhoneCWList * iResults

CMobilePhoneCWList * iResults [private]