Collapse all Symbian^3 Product Developer Library

CRetrieveMobilePhoneDetectedNetworks Class Reference

class CRetrieveMobilePhoneDetectedNetworks : public CAsyncRetrievePhoneList

Retrieves a list of all networks that are currently detected by the phone.

Each detected network will be represented by an entry in the list class CMobilePhoneNetworkList, CMobilePhoneNetworkListV2 or CMobilePhoneNetworkListV5 or CMobilePhoneNetworkListV8 depending on which API method is used.

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

CRetrieveMobilePhoneDetectedNetworks
- CAsyncRetrievePhoneList
  - CAsyncRetrieveWithClientIds
    - CAsyncRetrieveVariableLengthBufferV2
      - CActive
        CBase

Public Member Functions
	~CRetrieveMobilePhoneDetectedNetworks()
IMPORT_C CRetrieveMobilePhoneDetectedNetworks *	NewL(RMobilePhone &)
IMPORT_C CMobilePhoneNetworkList *	RetrieveListL()
IMPORT_C CMobilePhoneNetworkListV2 *	RetrieveListV2L()
IMPORT_C CMobilePhoneNetworkListV5 *	RetrieveListV5L()
IMPORT_C CMobilePhoneNetworkListV8 *	RetrieveListV8L()
IMPORT_C void	Start(TRequestStatus &)
IMPORT_C void	StartV2(TRequestStatus &)
IMPORT_C void	StartV5(TRequestStatus &)
IMPORT_C void	StartV8(TRequestStatus &)

Protected Member Functions
	CRetrieveMobilePhoneDetectedNetworks(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
TInt	iListExtensionId
CMobilePhoneNetworkList *	iResults
CMobilePhoneNetworkListV2 *	iResultsV2
CMobilePhoneNetworkListV5 *	iResultsV5
CMobilePhoneNetworkListV8 *	iResultsV8

Inherited Attributes
	CActive::iStatus
	CAsyncRetrievePhoneList::iPhone
	CAsyncRetrieveVariableLengthBufferV2::iIpcCancel
	CAsyncRetrieveVariableLengthBufferV2::iIpcPhase1
	CAsyncRetrieveVariableLengthBufferV2::iIpcPhase2
	CAsyncRetrieveVariableLengthBufferV2::iResultsBuf
	CAsyncRetrieveVariableLengthBufferV2::iResultsPtr
	CAsyncRetrieveVariableLengthBufferV2::iState
	CAsyncRetrieveWithClientIds::iId

Constructor & Destructor Documentation

CRetrieveMobilePhoneDetectedNetworks(RMobilePhone &)

CRetrieveMobilePhoneDetectedNetworks

(

RMobilePhone &

aPhone

)

[protected]

Parameters

RMobilePhone & aPhone

~CRetrieveMobilePhoneDetectedNetworks()

IMPORT_C

~CRetrieveMobilePhoneDetectedNetworks

(

)

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

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[protected]

NewL(RMobilePhone &)

IMPORT_C CRetrieveMobilePhoneDetectedNetworks *

NewL

(

RMobilePhone &

aPhone

)

[static]

This function member creates an instance of the CRetrieveMobilePhoneDetectedNetworks class.

capability: None

Parameters

RMobilePhone & aPhone

A reference to their 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 CMobilePhoneNetworkList *

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 CMobilePhoneNetworkList 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: None

RetrieveListV2L()

IMPORT_C CMobilePhoneNetworkListV2 *

RetrieveListV2L

(

)

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

When the client calls this function member the ownership of the CMobilePhoneNetworkListV2 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: None

RetrieveListV5L()

IMPORT_C CMobilePhoneNetworkListV5 *

RetrieveListV5L

(

)

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

When the client calls this function member the ownership of the CMobilePhoneNetworkListV5 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: None

RetrieveListV8L()

IMPORT_C CMobilePhoneNetworkListV8 *

RetrieveListV8L

(

)

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

When the client calls this function member the ownership of the CMobilePhoneNetworkListV8 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: None

Start(TRequestStatus &)

IMPORT_C void

Start

(

TRequestStatus &

aReqStatus

)

This function member starts the two-phase list retrieval of detected networks.

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 detected network store and KErrNotFound if the store does not exist. If the list is empty then KErrNone is returned.