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 TIntAddConnectionMethodL(RCmConnectionMethodExt)
IMPORT_C TIntAddEmbeddedDestinationL(const RCmDestinationExt &)
IMPORT_C voidClose()
IMPORT_C RCmConnectionMethodExtConnectionMethodByIDL(TInt)
IMPORT_C TIntConnectionMethodCount()
IMPORT_C RCmConnectionMethodExtConnectionMethodL(TInt)
IMPORT_C RCmConnectionMethodExtCreateConnectionMethodL(TUint32)
IMPORT_C RCmConnectionMethodExtCreateConnectionMethodL(TUint32, TUint32)
IMPORT_C voidDeleteConnectionMethodL(RCmConnectionMethodExt &)
IMPORT_C voidDeleteLD()
IMPORT_C TUint32ElementId()
IMPORT_C CGulIcon *IconL()
IMPORT_C TUint32Id()
IMPORT_C TBoolIsConnectedL()
IMPORT_C TBoolIsHidden()
IMPORT_C TUint32MetadataL(CMManager::TSnapMetadataField)
IMPORT_C voidModifyPriorityL(RCmConnectionMethodExt &, TUint)
IMPORT_C HBufC *NameLC()
IMPORT_C TUintPriorityL(const RCmConnectionMethodExt &)
IMPORT_C CMManager::TProtectionLevelProtectionLevel()
IMPORT_C voidRemoveConnectionMethodL(RCmConnectionMethodExt)
IMPORT_C voidSetHiddenL(TBool)
IMPORT_C voidSetIconL(TUint32)
IMPORT_C voidSetMetadataL(CMManager::TSnapMetadataField, TUint32)
IMPORT_C voidSetNameL(const TDesC &)
IMPORT_C voidSetProtectionL(CMManager::TProtectionLevel)
IMPORT_C voidUpdateL()
IMPORT_C TBooloperator!=(const RCmDestinationExt &)
IMPORT_C RCmDestinationExt &operator=(const RCmDestinationExt &)
IMPORT_C TBooloperator==(const RCmDestinationExt &)
Private Attributes
CCmDestinationData *iDestinatonData

Constructor & Destructor Documentation

RCmDestinationExt()

IMPORT_CRCmDestinationExt()

Default constructor.

RCmDestinationExt(const RCmDestinationExt &)

IMPORT_CRCmDestinationExt(const RCmDestinationExt &aCmDestination)

Parameters

const RCmDestinationExt & aCmDestination

~RCmDestinationExt()

IMPORT_C~RCmDestinationExt()

Member Functions Documentation

AddConnectionMethodL(RCmConnectionMethodExt)

IMPORT_C TIntAddConnectionMethodL(RCmConnectionMethodExtaConnectionMethod)

Parameters

RCmConnectionMethodExt aConnectionMethod

AddEmbeddedDestinationL(const RCmDestinationExt &)

IMPORT_C TIntAddEmbeddedDestinationL(const RCmDestinationExt &aDestination)

Parameters

const RCmDestinationExt & aDestination

Close()

IMPORT_C voidClose()

Close the session.

ConnectionMethodByIDL(TInt)

IMPORT_C RCmConnectionMethodExtConnectionMethodByIDL(TIntaCmId)

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

Parameters

TInt aCmIdunique id of the requested connection method.

ConnectionMethodCount()

IMPORT_C TIntConnectionMethodCount()

Return the number of connection methods in the destination

ConnectionMethodL(TInt)

IMPORT_C RCmConnectionMethodExtConnectionMethodL(TIntanIndex)

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

Parameters

TInt anIndexindex of the connection method to be returned

CreateConnectionMethodL(TUint32)

IMPORT_C RCmConnectionMethodExtCreateConnectionMethodL(TUint32aBearerType)

Create a connection method that belongs to this destination.

Parameters

TUint32 aBearerType

CreateConnectionMethodL(TUint32, TUint32)

IMPORT_C RCmConnectionMethodExtCreateConnectionMethodL(TUint32aBearerType,
TUint32aConnMethId
)

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

Parameters

TUint32 aBearerType
TUint32 aConnMethId

DeleteConnectionMethodL(RCmConnectionMethodExt &)

IMPORT_C voidDeleteConnectionMethodL(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 & aConnectionMethodthe connection method to be deleted.

DeleteLD()

IMPORT_C voidDeleteLD()

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

ElementId()

IMPORT_C TUint32ElementId()

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 TUint32Id()

Return the destination's Id attribute

IsConnectedL()

IMPORT_C TBoolIsConnectedL()const

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

IsHidden()

IMPORT_C TBoolIsHidden()

Return that the destination is hidden or not.

MetadataL(CMManager::TSnapMetadataField)

IMPORT_C TUint32MetadataL(CMManager::TSnapMetadataFieldaMetaField)const

Return the Metadata

Parameters

CMManager::TSnapMetadataField aMetaField

ModifyPriorityL(RCmConnectionMethodExt &, TUint)

IMPORT_C voidModifyPriorityL(RCmConnectionMethodExt &aCCMItem,
TUintaIndex
)

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

Parameters

RCmConnectionMethodExt & aCCMItemthe connection method item
TUint aIndexthe 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 TUintPriorityL(const RCmConnectionMethodExt &aCCMItem)

Return the priority of the passed connection method

Parameters

const RCmConnectionMethodExt & aCCMItemconnection method

ProtectionLevel()

IMPORT_C CMManager::TProtectionLevelProtectionLevel()

Return the protection level of the destination.

RemoveConnectionMethodL(RCmConnectionMethodExt)

IMPORT_C voidRemoveConnectionMethodL(RCmConnectionMethodExtaConnectionMethod)

Remove connection method from the destination

Parameters

RCmConnectionMethodExt aConnectionMethodconnection method to be removed

SetHiddenL(TBool)

IMPORT_C voidSetHiddenL(TBoolaHidden)

Set if the destination is hidden or not.

Parameters

TBool aHidden- ETrue if destination is hidden

SetIconL(TUint32)

IMPORT_C voidSetIconL(TUint32anIndex)

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 voidSetMetadataL(CMManager::TSnapMetadataFieldaMetaField,
TUint32aValue
)

Set the Metadata

Parameters

CMManager::TSnapMetadataField aMetaFieldfield to be modified
TUint32 aValuevalue to be set

SetNameL(const TDesC &)

IMPORT_C voidSetNameL(const TDesC &aName)

Set the destination's name

Parameters

const TDesC & aName

SetProtectionL(CMManager::TProtectionLevel)

IMPORT_C voidSetProtectionL(CMManager::TProtectionLevelaProtLevel)

Set the protection level of the destination.

Parameters

CMManager::TProtectionLevel aProtLevelnew protection level

UpdateL()

IMPORT_C voidUpdateL()

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 TBooloperator!=(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 TBooloperator==(const RCmDestinationExt &aDestination)const

Compares whether two objects content is the same.

Parameters

const RCmDestinationExt & aDestination

Member Data Documentation

CCmDestinationData * iDestinatonData

CCmDestinationData *iDestinatonData[private]