EPOC   SDK Home Glossary Indexes Previous Next Up

CGsmDetectedNetworkResults class


Contents


CGsmDetectedNetworkResults class — Storage of network results

Section Contents


Overview

Derivation

CBase

Abstract: CBase behaviour

Defined in

etelbgsm.h

Link against

gsmbas.lib

Description

This class is used to store the results of searches for detected networks — see MBasicGsmPhoneNetwork::RetrieveDetectedNetworksLC() and CBasicGsmRetrieveDetectedNetworks::RetrieveResults().

In both cases, instances of this class are created by the respective function. In the asynchronous variant the results are owned by the CBasicGsmRetrieveDetectedNetworks class. In the synchronous variant the results are placed on the clean-up stack, and are owned by the client.

Writing derived classes

This class is not intended for user derivation


Construction and destruction

Clients should not call a constructor to create this object. Instances of this class are created by the functions used to initiate the search.


~CGsmDetectedNetworkResults() — Destructor

~CGsmDetectedNetworkResults();

Description

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


Query functions


EnumerateEntries() — Enumerate detected network search results

TInt EnumerateEntries(TInt& aCount);

Description

This function retrieves the number of entries in the results list — i.e. the number of detected networks.

Arguments

TInt& aCount

On return, contains the number of detected networks.

Return value

TInt

An error code: see System error codes.


GetEntry() — Get entry by index

TInt GetEntry(const TInt aIndex, RBasicGsmPhone::TNetworkInfo& aEntry);

Description

This function retrieves a specific detected network entry from the search results.

Arguments

const TInt aIndex

The index of the detected network entry to be returned.

RBasicGsmPhone::TNetworkInfo& aEntry

On return, contains the specified detected network information.

Return value

TInt

An error code: see System error codes.

Notes:

GetNextEntry() — Get next entry

TInt GetNextEntry(RBasicGsmPhone::TNetworkInfo& aEntry);

Description

This function returns the next detected network entry, with respect to the results cursor, in a search result list.

Arguments

RBasicGsmPhone::TNetworkInfo& aEntry

On return, contains the next entry.

Return value

TInt

An error code: see System error codes.

Notes:

GetPreviousEntry() — Get previous entry

TInt GetPreviousEntry(RBasicGsmPhone::TNetworkInfo& aEntry);

Description

This function returns the previous detected network entry, with respect to the results cursor, in a search result list.

Arguments

RBasicGsmPhone::TNetworkInfo& aEntry

On return, contains the previous entry.

Return value

TInt

An error code: see System error codes.

Notes:

Reset() — Reset all entries

void Reset();

Description

This function resets all entries in the search results list to zero.


Enumerations


Anonymous enum — Panic constant

KPanicInvalidResultsIndex

Panic constant for browsing list

EPOC       SDK Home Glossary Indexes Previous Next Up