Collapse all Symbian^3 Product Developer Library

RCmManagerExt Class Reference

class RCmManagerExt

RCmManager is used to query and modify network destinations and connection methods.

cmmanager.lib

Since: S60 v3.2

Public Member Functions
	RCmManagerExt()
IMPORT_C void	AllDestinationsL(RArray< TUint32 > &)
IMPORT_C void	BearerPriorityArrayL(RArray< TBearerPriority > &)
IMPORT_C void	CleanupGlobalPriorityArray(RArray< TBearerPriority > &)
IMPORT_C void	Close()
IMPORT_C RCmConnectionMethodExt	ConnectionMethodL(TUint32)
IMPORT_C void	ConnectionMethodL(RArray< TUint32 > &, TBool, TBool, TBool)
IMPORT_C TInt	CopyConnectionMethodL(RCmDestinationExt &, RCmConnectionMethodExt &)
IMPORT_C RCmConnectionMethodExt	CreateConnectionMethodL(TUint32)
IMPORT_C RCmConnectionMethodExt	CreateConnectionMethodL(TUint32, TUint32)
IMPORT_C RCmDestinationExt	CreateDestinationL(const TDesC &)
IMPORT_C RCmDestinationExt	CreateDestinationL(const TDesC &, TUint32)
IMPORT_C void	CreateTablesAndOpenL()
IMPORT_C RCmDestinationExt	DestinationL(TUint32)
IMPORT_C TUint32	EasyWlanIdL()
IMPORT_C TBool	GetBearerInfoBoolL(TUint32, TUint32)
IMPORT_C TUint32	GetBearerInfoIntL(TUint32, TUint32)
IMPORT_C HBufC8 *	GetBearerInfoString8L(TUint32, TUint32)
IMPORT_C HBufC *	GetBearerInfoStringL(TUint32, TUint32)
IMPORT_C TBool	GetConnectionMethodInfoBoolL(TUint32, TUint32)
IMPORT_C TUint32	GetConnectionMethodInfoIntL(TUint32, TUint32)
IMPORT_C HBufC8 *	GetConnectionMethodInfoString8L(TUint32, TUint32)
IMPORT_C HBufC *	GetConnectionMethodInfoStringL(TUint32, TUint32)
IMPORT_C TInt	MoveConnectionMethodL(RCmDestinationExt &, RCmDestinationExt &, RCmConnectionMethodExt &)
IMPORT_C void	OpenL()
IMPORT_C void	OpenLC()
IMPORT_C void	ReadDefConnL(TCmDefConnValue &)
IMPORT_C void	RemoveAllReferencesL(RCmConnectionMethodExt &)
IMPORT_C void	RemoveConnectionMethodL(RCmDestinationExt &, RCmConnectionMethodExt &)
IMPORT_C void	SupportedBearersL(RArray< TUint32 > &)
IMPORT_C CGulIcon *	UncategorizedIconL()
IMPORT_C void	UpdateBearerPriorityArrayL(const RArray< TBearerPriority > &)
IMPORT_C void	WriteDefConnL(const TCmDefConnValue &)

Private Member Functions
	RCmManagerExt(RCmManagerExt &)
RCmManagerExt &	operator=(RCmManagerExt &)

Private Attributes
CCmManagerImpl *	iImplementation

Constructor & Destructor Documentation

RCmManagerExt()

RCmManagerExt

(

)

[inline]

Inline constructor

RCmManagerExt(RCmManagerExt &)

RCmManagerExt

(

RCmManagerExt &

)

[private]

This is a private copy constructor without iplemetation. The sole purpose of this declaration is to forbid the copying of the objects of this class.

Parameters

RCmManagerExt &

Member Functions Documentation

AllDestinationsL(RArray< TUint32 > &)

IMPORT_C void

AllDestinationsL

(

RArray< TUint32 > &

aDestArray

)

Returns an array of all destination id's

Parameters

RArray< TUint32 > & aDestArray

array of all available network destination

BearerPriorityArrayL(RArray< TBearerPriority > &)

IMPORT_C void

BearerPriorityArrayL

(

RArray< TBearerPriority > &

aArray

)

const

Returns the copy of the bearer priority array. Ownership is passed.

Parameters

RArray< TBearerPriority > & aArray

bearer priority array

CleanupGlobalPriorityArray(RArray< TBearerPriority > &)

IMPORT_C void

CleanupGlobalPriorityArray

(

RArray< TBearerPriority > &

aArray

)

const

Clean up passed global bearer priority array. Delete the elements and calls Reset and Close on the array.

Parameters

RArray< TBearerPriority > & aArray

array to be cleaned up

Close()

IMPORT_C void

(

)

Close session

ConnectionMethodL(TUint32)

IMPORT_C RCmConnectionMethodExt

ConnectionMethodL

(

TUint32

aConnectionMethodId

)

Returns the connection method queried by its ID.

Parameters

TUint32 aConnectionMethodId

ConnectionMethodL(RArray< TUint32 > &, TBool, TBool, TBool)

IMPORT_C void	ConnectionMethodL	(	RArray< TUint32 > &	aCMArray,
			TBool	aCheckBearerType = ETrue,
			TBool	aLegacyOnly = ETrue,
			TBool	aEasyWlan = EFalse
		)

Returns the list of connection methods that do not belong to any destination

Parameters

RArray< TUint32 > & aCMArray	on return it is the array of IAP ids.
TBool aCheckBearerType = ETrue	If ETrue only connection methods with supported bearer types are returned
TBool aLegacyOnly = ETrue	when set to ETrue only Legacy IAP ids will be returned
TBool aEasyWlan = EFalse	when set to ETrue EasyWlan id is returned, too

CopyConnectionMethodL(RCmDestinationExt &, RCmConnectionMethodExt &)

IMPORT_C TInt	CopyConnectionMethodL	(	RCmDestinationExt &	aTargetDestination,
			RCmConnectionMethodExt &	aConnectionMethod
		)

Copies a connection method belonging to one destination to another. The connection method becomes shared. Calls UpdateL on the destination

Parameters

RCmDestinationExt & aTargetDestination
RCmConnectionMethodExt & aConnectionMethod

CreateConnectionMethodL(TUint32)

IMPORT_C RCmConnectionMethodExt

CreateConnectionMethodL

(

TUint32

aBearerType

)

Creates a connection method does not belong to any destination

Parameters

TUint32 aBearerType

CreateConnectionMethodL(TUint32, TUint32)

IMPORT_C RCmConnectionMethodExt	CreateConnectionMethodL	(	TUint32	aImplementationUid,
			TUint32	aConnMethodId
		)

Creates a connection method does not belong to any destination

Parameters

TUint32 aImplementationUid	- bearer type of the new connection method
TUint32 aConnMethodId	Predefined id for the connection method (id range is from 1 to max IAP record amount in CommsDat).

CreateDestinationL(const TDesC &)

IMPORT_C RCmDestinationExt

CreateDestinationL

(

const TDesC &

aName

)

Creates a Destination with the passed name.

Parameters

const TDesC & aName

the name of the new destination.

CreateDestinationL(const TDesC &, TUint32)

IMPORT_C RCmDestinationExt	CreateDestinationL	(	const TDesC &	aName,
			TUint32	aDestId
		)

Creates a Destination with the passed name and id.

Parameters

const TDesC & aName	the name of the new destination.
TUint32 aDestId	Predefined id of the destination.

CreateTablesAndOpenL()

IMPORT_C void

CreateTablesAndOpenL

(

)

Open session and create tables if they don't exist

DestinationL(TUint32)

IMPORT_C RCmDestinationExt

DestinationL

(

TUint32

aDestinationId

)

Returns the destination to which a specified connection method belongs, search is by destination ID

Parameters

TUint32 aDestinationId

id of the destination

EasyWlanIdL()

IMPORT_C TUint32

EasyWlanIdL

(

)

Returns the id of the EasyWlan connection method.

Since: S60 3.2

GetBearerInfoBoolL(TUint32, TUint32)

IMPORT_C TBool	GetBearerInfoBoolL	(	TUint32	aBearerType,
			TUint32	aAttribute
		)	const

Parameters

TUint32 aBearerType
TUint32 aAttribute

GetBearerInfoIntL(TUint32, TUint32)

IMPORT_C TUint32	GetBearerInfoIntL	(	TUint32	aBearerType,
			TUint32	aAttribute
		)	const

GetBearerInfoXXX function can be used to query bearer informantion that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc. NULL pointer, returned from string functions, means attribute exists but has no value. HBuf ownership is passed to the caller

Parameters

TUint32 aBearerType
TUint32 aAttribute

GetBearerInfoString8L(TUint32, TUint32)

IMPORT_C HBufC8 *	GetBearerInfoString8L	(	TUint32	aBearerType,
			TUint32	aAttribute
		)	const

Parameters

TUint32 aBearerType
TUint32 aAttribute

GetBearerInfoStringL(TUint32, TUint32)

IMPORT_C HBufC *	GetBearerInfoStringL	(	TUint32	aBearerType,
			TUint32	aAttribute
		)	const

Parameters

TUint32 aBearerType
TUint32 aAttribute

GetConnectionMethodInfoBoolL(TUint32, TUint32)

IMPORT_C TBool	GetConnectionMethodInfoBoolL	(	TUint32	aIapId,
			TUint32	aAttribute
		)	const

Parameters

TUint32 aIapId
TUint32 aAttribute

GetConnectionMethodInfoIntL(TUint32, TUint32)

IMPORT_C TUint32	GetConnectionMethodInfoIntL	(	TUint32	aIapId,
			TUint32	aAttribute
		)	const

GetConnectionMethodInfoXXX function can be used to query any, non-bearer specific information about a given connection method. This can be e.g. ECmBearerType, ECmName, ECmStartPage etc. NULL pointer, returned from string functions, means attribute exists but has no value. HBuf ownership is passed to the caller

Parameters

TUint32 aIapId
TUint32 aAttribute

GetConnectionMethodInfoString8L(TUint32, TUint32)

IMPORT_C HBufC8 *	GetConnectionMethodInfoString8L	(	TUint32	aIapId,
			TUint32	aAttribute
		)	const

Parameters

TUint32 aIapId
TUint32 aAttribute

GetConnectionMethodInfoStringL(TUint32, TUint32)

IMPORT_C HBufC *	GetConnectionMethodInfoStringL	(	TUint32	aIapId,
			TUint32	aAttribute
		)	const

Parameters

TUint32 aIapId
TUint32 aAttribute

MoveConnectionMethodL(RCmDestinationExt &, RCmDestinationExt &, RCmConnectionMethodExt &)

IMPORT_C TInt	MoveConnectionMethodL	(	RCmDestinationExt &	aSourceDestination,
			RCmDestinationExt &	aTargetDestination,
			RCmConnectionMethodExt &	aConnectionMethod
		)

Moves a connection method belonging to one destination to another. The connection method is removed from the source destination

Parameters

RCmDestinationExt & aSourceDestination
RCmDestinationExt & aTargetDestination
RCmConnectionMethodExt & aConnectionMethod

OpenL()

IMPORT_C void

OpenL

(

)

Open session

OpenLC()

IMPORT_C void

OpenLC

(

)

Symbian constructor Pushes the object on the cleanup stack

Since: S60 3.2

ReadDefConnL(TCmDefConnValue &)

IMPORT_C void

ReadDefConnL

(

TCmDefConnValue &

aDCSetting

)

Returns the default connection method/SNAP.

Since: S60 3.2

Parameters

TCmDefConnValue & aDCSetting

RemoveAllReferencesL(RCmConnectionMethodExt &)

IMPORT_C void

RemoveAllReferencesL

(

RCmConnectionMethodExt &

aConnectionMethod

)

Removes connection method from every destination and make it uncategorized.

Parameters

RCmConnectionMethodExt & aConnectionMethod

connection method to be removed

RemoveConnectionMethodL(RCmDestinationExt &, RCmConnectionMethodExt &)

IMPORT_C void	RemoveConnectionMethodL	(	RCmDestinationExt &	aDestination,
			RCmConnectionMethodExt &	aConnectionMethod
		)

Remove connection method from the destination

Parameters

RCmDestinationExt & aDestination	destination the connection method is attached to
RCmConnectionMethodExt & aConnectionMethod	connection method to be removed

SupportedBearersL(RArray< TUint32 > &)

IMPORT_C void

SupportedBearersL

(

RArray< TUint32 > &

aArray

)

const

Query all of the supported bearer types.

Parameters

RArray< TUint32 > & aArray

list of all supported bearer types.

UncategorizedIconL()

IMPORT_C CGulIcon *

UncategorizedIconL

(

)

const

Returns "Uncategorized" icon. This fucton leaves if the client does not have a valid UI context

UpdateBearerPriorityArrayL(const RArray< TBearerPriority > &)

IMPORT_C void

UpdateBearerPriorityArrayL

(

const RArray< TBearerPriority > &

aArray

)

Update bearer priority array

Parameters

const RArray< TBearerPriority > & aArray

array with new global bearer priority

WriteDefConnL(const TCmDefConnValue &)

IMPORT_C void

WriteDefConnL

(

const TCmDefConnValue &

aDCSetting

)

Stores the default connection method/SNAP.

Since: S60 3.2

Parameters

const TCmDefConnValue & aDCSetting

operator=(RCmManagerExt &)

RCmManagerExt &

operator=

(

RCmManagerExt &

)

[private]

This is a private copy constructor without iplemetation. The sole purpose of this declaration is to forbid the copying of the objects of this class.

Parameters

RCmManagerExt &

Member Data Documentation

CCmManagerImpl * iImplementation

CCmManagerImpl *

iImplementation

[private]