Symbian^3 Application Developer Library >

CRetrieveMobilePhoneCBList Class Reference

class CRetrieveMobilePhoneCBList : public CAsyncRetrievePhoneList

Retrieves the Call Barring status list from the phone.

The following are all described as applicable to both GSM and CDMA because although it is not possible to interrogate CDMA networks for call barring service status there is nothing inherently "GSM" about these types. So if the phone has attempted to internally support Call Barring in CDMA mode then these types are applicable.

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

Inherits from

Nested Classes and Structures

Public Member Functions
~CRetrieveMobilePhoneCBList ()
IMPORT_C CRetrieveMobilePhoneCBList * NewL ( RMobilePhone &)
IMPORT_C CMobilePhoneCBList * RetrieveListL ()
IMPORT_C void Start ( TRequestStatus &, RMobilePhone::TMobilePhoneCBCondition , RMobilePhone::TMobileInfoLocation )
Protected Member Functions
CRetrieveMobilePhoneCBList ( 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 < TGetCallBarringRequest > iCBRequestData
TInt iListExtensionId
CMobilePhoneCBList * iResults
Inherited Attributes
CActive::iStatus
CAsyncRetrievePhoneList::iPhone
CAsyncRetrieveVariableLengthBufferV2::iIpcCancel
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase1
CAsyncRetrieveVariableLengthBufferV2::iIpcPhase2
CAsyncRetrieveVariableLengthBufferV2::iResultsBuf
CAsyncRetrieveVariableLengthBufferV2::iResultsPtr
CAsyncRetrieveVariableLengthBufferV2::iState
CAsyncRetrieveWithClientIds::iId

Constructor & Destructor Documentation

CRetrieveMobilePhoneCBList(RMobilePhone &)

CRetrieveMobilePhoneCBList ( RMobilePhone & aPhone ) [protected]

Parameters

RMobilePhone & aPhone

~CRetrieveMobilePhoneCBList()

IMPORT_C ~CRetrieveMobilePhoneCBList ( )

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

Member Functions Documentation

ConstructL()

void ConstructL ( ) [protected]

NewL(RMobilePhone &)

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

This member function creates an instance of the CRetrieveMobilePhoneCBList class.

capability
None

Parameters

RMobilePhone & aPhone A reference to the RMobilePhone sub-session, as it is this 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 CMobilePhoneCBList * 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. The retrieved list will consist of an entry per basic service group per specified CB condition.

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

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

This member function starts the two-phase list retrieval. The client also specifies the call barring condition(s) that it wants to interrogate and from where this information should be retrieved. The client then waits for its request to be completed.

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 CB list store and KErrNotFound if the store does not exist. If the list is empty then KErrNone is returned.
RMobilePhone::TMobilePhoneCBCondition aCondition The barring conditions to interrogate.
RMobilePhone::TMobileInfoLocation aLocation = RMobilePhone::EInfoLocationCachePreferred Specifies from where this information should be retrieved. This parameters defaults to: RMobilePhone::EInfoLocationCachePreferred.

Member Data Documentation

TPckgBuf< TGetCallBarringRequest > iCBRequestData

TPckgBuf < TGetCallBarringRequest > iCBRequestData [private]

TInt iListExtensionId

TInt iListExtensionId [private]

CMobilePhoneCBList * iResults

CMobilePhoneCBList * iResults [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.