Symbian^3 Application Developer Library >

RCmDestinationExt Class Reference

class RCmDestinationExt
RCmDestination is for getting/setting values of a network destination. cmmanager.lib
Since
S60 v3.2
Public Member Functions
RCmDestinationExt ()
RCmDestinationExt (const RCmDestinationExt &)
~RCmDestinationExt ()
IMPORT_C TInt AddConnectionMethodL ( RCmConnectionMethodExt )
IMPORT_C TInt AddEmbeddedDestinationL (const RCmDestinationExt &)
IMPORT_C void Close ()
IMPORT_C RCmConnectionMethodExt ConnectionMethodByIDL ( TInt )
IMPORT_C TInt ConnectionMethodCount ()
IMPORT_C RCmConnectionMethodExt ConnectionMethodL ( TInt )
IMPORT_C RCmConnectionMethodExt CreateConnectionMethodL ( TUint32 )
IMPORT_C RCmConnectionMethodExt CreateConnectionMethodL ( TUint32 , TUint32 )
IMPORT_C void DeleteConnectionMethodL ( RCmConnectionMethodExt &)
IMPORT_C void DeleteLD ()
IMPORT_C TUint32 ElementId ()
IMPORT_C CGulIcon * IconL ()
IMPORT_C TUint32 Id ()
IMPORT_C TBool IsConnectedL ()
IMPORT_C TBool IsHidden ()
IMPORT_C TUint32 MetadataL ( CMManager::TSnapMetadataField )
IMPORT_C void ModifyPriorityL ( RCmConnectionMethodExt &, TUint )
IMPORT_C HBufC * NameLC ()
IMPORT_C TUint PriorityL (const RCmConnectionMethodExt &)
IMPORT_C CMManager::TProtectionLevel ProtectionLevel ()
IMPORT_C void RemoveConnectionMethodL ( RCmConnectionMethodExt )
IMPORT_C void SetHiddenL ( TBool )
IMPORT_C void SetIconL ( TUint32 )
IMPORT_C void SetMetadataL ( CMManager::TSnapMetadataField , TUint32 )
IMPORT_C void SetNameL (const TDesC &)
IMPORT_C void SetProtectionL ( CMManager::TProtectionLevel )
IMPORT_C void UpdateL ()
IMPORT_C TBool operator!= (const RCmDestinationExt &)
IMPORT_C RCmDestinationExt & operator= (const RCmDestinationExt &)
IMPORT_C TBool operator== (const RCmDestinationExt &)
Private Attributes
CCmDestinationData * iDestinatonData

Constructor & Destructor Documentation

RCmDestinationExt()

IMPORT_C RCmDestinationExt ( )

Default constructor.

RCmDestinationExt(const RCmDestinationExt &)

IMPORT_C RCmDestinationExt ( const RCmDestinationExt & aCmDestination )

Parameters

const RCmDestinationExt & aCmDestination

~RCmDestinationExt()

IMPORT_C ~RCmDestinationExt ( )

Member Functions Documentation

AddConnectionMethodL(RCmConnectionMethodExt)

IMPORT_C TInt AddConnectionMethodL ( RCmConnectionMethodExt aConnectionMethod )

Parameters

RCmConnectionMethodExt aConnectionMethod

AddEmbeddedDestinationL(const RCmDestinationExt &)

IMPORT_C TInt AddEmbeddedDestinationL ( const RCmDestinationExt & aDestination )

Parameters

const RCmDestinationExt & aDestination

Close()

IMPORT_C void Close ( )

Close the session.

ConnectionMethodByIDL(TInt)

IMPORT_C RCmConnectionMethodExt ConnectionMethodByIDL ( TInt aCmId )

Returns the connection method with the ECmId. Leaves with KErrNotFound if not found.

Parameters

TInt aCmId unique id of the requested connection method.

ConnectionMethodCount()

IMPORT_C TInt ConnectionMethodCount ( )

Return the number of connection methods in the destination

ConnectionMethodL(TInt)

IMPORT_C RCmConnectionMethodExt ConnectionMethodL ( TInt anIndex )

Return a reference to the connection method. The index must be less than the return value of ConnectionMethodCount()

Parameters

TInt anIndex index of the connection method to be returned

CreateConnectionMethodL(TUint32)

IMPORT_C RCmConnectionMethodExt CreateConnectionMethodL ( TUint32 aBearerType )

Create a connection method that belongs to this destination.

Parameters

TUint32 aBearerType

CreateConnectionMethodL(TUint32, TUint32)

IMPORT_C RCmConnectionMethodExt CreateConnectionMethodL ( TUint32 aBearerType,
TUint32 aConnMethId
)

Create a connection method with given id that belongs to this destination.

Parameters

TUint32 aBearerType
TUint32 aConnMethId

DeleteConnectionMethodL(RCmConnectionMethodExt &)

IMPORT_C void DeleteConnectionMethodL ( RCmConnectionMethodExt & aConnectionMethod )

Remove a connection method from a destination and delete it on update. Exception: conenction method is not deleted if it's referenced from any other destination.

Parameters

RCmConnectionMethodExt & aConnectionMethod the connection method to be deleted.

DeleteLD()

IMPORT_C void DeleteLD ( )

Delete destination and its connection methods from CommsDat. Connection methods that belong to other destination, too, are not deleted.

ElementId()

IMPORT_C TUint32 ElementId ( )

Return the destination's ElementId attribute

IconL()

IMPORT_C CGulIcon * IconL ( )

Return the Icon pointer. Ownership is passed. This fucton leaves if the client does not have a valid UI context

Id()

IMPORT_C TUint32 Id ( )

Return the destination's Id attribute

IsConnectedL()

IMPORT_C TBool IsConnectedL ( ) const

Returns if there's connection created with any of the destination's connection method.

IsHidden()

IMPORT_C TBool IsHidden ( )

Return that the destination is hidden or not.

MetadataL(CMManager::TSnapMetadataField)

IMPORT_C TUint32 MetadataL ( CMManager::TSnapMetadataField aMetaField ) const

Return the Metadata

Parameters

CMManager::TSnapMetadataField aMetaField

ModifyPriorityL(RCmConnectionMethodExt &, TUint)

IMPORT_C void ModifyPriorityL ( RCmConnectionMethodExt & aCCMItem,
TUint aIndex
)

Set the connection method's priority based on the passed index. Indexing starts from zero(the highest priority).

Parameters

RCmConnectionMethodExt & aCCMItem the connection method item
TUint aIndex the new priority of the connection method in the destination

NameLC()

IMPORT_C HBufC * NameLC ( )

Return the name of the destination. Ownership is passed. HBuf ownership is passed to the caller

PriorityL(const RCmConnectionMethodExt &)

IMPORT_C TUint PriorityL ( const RCmConnectionMethodExt & aCCMItem )

Return the priority of the passed connection method

Parameters

const RCmConnectionMethodExt & aCCMItem connection method

ProtectionLevel()

IMPORT_C CMManager::TProtectionLevel ProtectionLevel ( )

Return the protection level of the destination.

RemoveConnectionMethodL(RCmConnectionMethodExt)

IMPORT_C void RemoveConnectionMethodL ( RCmConnectionMethodExt aConnectionMethod )

Remove connection method from the destination

Parameters

RCmConnectionMethodExt aConnectionMethod connection method to be removed

SetHiddenL(TBool)

IMPORT_C void SetHiddenL ( TBool aHidden )

Set if the destination is hidden or not.

Parameters

TBool aHidden - ETrue if destination is hidden

SetIconL(TUint32)

IMPORT_C void SetIconL ( TUint32 anIndex )

Set the destination's icon index. This fucton leaves if the client does not have a valid UI context

Parameters

TUint32 anIndex

SetMetadataL(CMManager::TSnapMetadataField, TUint32)

IMPORT_C void SetMetadataL ( CMManager::TSnapMetadataField aMetaField,
TUint32 aValue
)

Set the Metadata

Parameters

CMManager::TSnapMetadataField aMetaField field to be modified
TUint32 aValue value to be set

SetNameL(const TDesC &)

IMPORT_C void SetNameL ( const TDesC & aName )

Set the destination's name

Parameters

const TDesC & aName

SetProtectionL(CMManager::TProtectionLevel)

IMPORT_C void SetProtectionL ( CMManager::TProtectionLevel aProtLevel )

Set the protection level of the destination.

Parameters

CMManager::TProtectionLevel aProtLevel new protection level

UpdateL()

IMPORT_C void UpdateL ( )

Update all values of the destination and its connection method. Nothing if stored, if update leaves due to any reason.

operator!=(const RCmDestinationExt &)

IMPORT_C TBool operator!= ( const RCmDestinationExt & aDestination ) const

Compares whether two objects content is different.

Parameters

const RCmDestinationExt & aDestination

operator=(const RCmDestinationExt &)

IMPORT_C RCmDestinationExt & operator= ( const RCmDestinationExt & aCmDestination )

assignment operator

Since
S60 3.2

Parameters

const RCmDestinationExt & aCmDestination

operator==(const RCmDestinationExt &)

IMPORT_C TBool operator== ( const RCmDestinationExt & aDestination ) const

Compares whether two objects content is the same.

Parameters

const RCmDestinationExt & aDestination

Member Data Documentation

CCmDestinationData * iDestinatonData

CCmDestinationData * iDestinatonData [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.