EPOC   SDK Home Glossary Indexes Previous Next Up

CBasicGsmRetrieveDetectedNetworks class


Contents


CBasicGsmRetrieveDetectedNetworks class — Retrieval of network results

Section Contents


Overview

Derivation

CActive

Abstract: active object: provides facilities to encapsulate an asynchronous service, and to handle its completion using RunL().

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

This class is used to retrieve — asynchronously — all the networks detected by a phone. The results are retrieved in a CGsmDetectedNetworkResults object, which is owned by this class.

The use of this class is discussed in Asynchronously retrieving detected networks.

Writing derived classes

This class is not intended for user derivation.


Construction and destruction


NewL() — Static constructor for CBasicGsmRetrieveDetectedNetworks

static CBasicGsmRetrieveDetectedNetworks* NewL(RBasicGsmPhone& aPhone);

Description

Use this function to create a new CBasicGsmRetrieveDetectedNetworks active object. If there is insufficient memory available to create this object, the function leaves.

Arguments

RBasicGsmPhone& aPhone

The phone for which all detected networks are to be found.

Return value

CBasicGsmRetrieveDetectedNetworks*

A pointer to the newly created active object for retrieving the detected networks


~CBasicGsmRetrieveDetectedNetworks() — Destructor

~CBasicGsmRetrieveDetectedNetworks();

Description

The destructor invokes Cancel() to cancel any outstanding request, and removes the object from the active scheduler. It then frees all resources owned by this object, prior to its destruction.


Retrieval functions


Start() — Start the retrieval process

void Start(TRequestStatus& aStatus);

Description

This function initiates the detected network retrieval process.

Arguments

TRequestStatus& aStatus

The variable that indicates when the detected network information retrieval is complete.

Note

RetrieveResults() — Get the results of the retrieval

CGsmDetectedNetworkResults* RetrieveResults() const;

Description

This function retrieves a pointer to the container class CGsmDetectedNetworkResults, which contains the search results.

Return value

CGsmDetectedNetworkResults*

A pointer to the detected network retrieval results.

EPOC       SDK Home Glossary Indexes Previous Next Up