RCmDestination Class Reference

#include <mw/cmdestination.h>

Link against: cmmanager.lib

class RCmDestination

Detailed Description

RCmDestination is for setting/getting values of a network destination.

Since
S60 v3.2

Constructor & Destructor Documentation

RCmDestination ( )

IMPORT_CRCmDestination()

Default constructor.

RCmDestination ( const RCmDestination & )

IMPORT_CRCmDestination(const RCmDestination &aCmDestination)

~RCmDestination ( )

IMPORT_C~RCmDestination()

Member Function Documentation

AddConnectionMethodL ( RCmConnectionMethod )

IMPORT_C TIntAddConnectionMethodL(RCmConnectionMethodaConnectionMethod)

AddEmbeddedDestinationL ( const RCmDestination & )

IMPORT_C TIntAddEmbeddedDestinationL(const RCmDestination &aDestination)

Close ( )

IMPORT_C voidClose()

Close the session.

Since
S60 3.2

ConnectionMethodByIDL ( TInt )

IMPORT_C RCmConnectionMethodConnectionMethodByIDL(TIntaCmId)const

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

ParameterDescription
aCmIdunique id of the requested connection method.

Returns: connection method

ConnectionMethodCount ( )

IMPORT_C TIntConnectionMethodCount()const

Returns the number of connection methods of the destination

Since
3.2

Returns: the number of connection methods belonging to a destination

ConnectionMethodL ( TInt )

IMPORT_C RCmConnectionMethodConnectionMethodL(TIntanIndex)const

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

Since
3.2

Returns: a connection method

CreateConnectionMethodL ( TUint32 )

IMPORT_C RCmConnectionMethodCreateConnectionMethodL(TUint32aBearerType)

Create a connection method that belongs to this destination.

Returns: newly created connection method

CreateConnectionMethodL ( TUint32, TUint32 )

IMPORT_C RCmConnectionMethodCreateConnectionMethodL(TUint32aBearerType,
TUint32aConnMethId
)

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

Returns: newly created connection method or leaves with KErrAlreadyExists if there exists CM with the same Id.

DeleteConnectionMethodL ( RCmConnectionMethod & )

IMPORT_C voidDeleteConnectionMethodL(RCmConnectionMethod &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.

ParameterDescription
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()const

Returns the destination's ElementId attribute

Since
3.2

Returns: the destination's element id

IconL ( )

IMPORT_C CGulIcon *IconL()const

Returns the Icon pointer This function leaves if the client does not have a valid UI context

Since
3.2

Returns: the destination icon

Id ( )

IMPORT_C TUint32Id()const

Returns the destination's Id attribute

Since
3.2

Returns: the destination's id

IsConnectedL ( )

IMPORT_C TBoolIsConnectedL()const

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

Since
3.2

Returns: ETrue if there's a connection with any of the destination's connection method.

IsHidden ( )

IMPORT_C TBoolIsHidden()const

Returns whether the destination is hidden or not.

Since
3.2

Returns: ETrue if the destination is hidden

MetadataL ( CMManager::TSnapMetadataField )

IMPORT_C TUint32MetadataL(CMManager::TSnapMetadataFieldaMetaField)const

Returns the Metadata

Since
3.2
ParameterDescription
aMetaFieldthe meta data field to query

Returns: the value of the requested field

ModifyPriorityL ( RCmConnectionMethod &, TUint )

IMPORT_C voidModifyPriorityL(RCmConnectionMethod &aCCMItem,
TUintaIndex
)

Set the connection method's priority based on the passed index.

ParameterDescription
aCCMItemthe connection method item
aIndexthe new priority of the connection method in the destination

NameLC ( )

IMPORT_C HBufC *NameLC()const

Returns the destination's Name attribute HBuf ownership is passed to the caller

Since
3.2

Returns: HBufC* Passes returned value's ownership to the caller

PriorityL ( const RCmConnectionMethod & )

IMPORT_C TUintPriorityL(const RCmConnectionMethod &aCCMItem)const

Return the priority of the passed connection method

Since
3.2
ParameterDescription
aCCMItemconnection method

Returns: the priority of the queried connection method

ProtectionLevel ( )

IMPORT_C CMManager::TProtectionLevelProtectionLevel()const

Return the protection level of the destination.

Since
3.2

Returns: protection level of the destination

RemoveConnectionMethodL ( RCmConnectionMethod )

IMPORT_C voidRemoveConnectionMethodL(RCmConnectionMethodaConnectionMethod)

Remove connection method from the destination

ParameterDescription
aConnectionMethodconnection method to be removed

SetHiddenL ( TBool )

IMPORT_C voidSetHiddenL(TBoolaHidden)

Set if the destination is hidden or not.

ParameterDescription
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

SetMetadataL ( CMManager::TSnapMetadataField, TUint32 )

IMPORT_C voidSetMetadataL(CMManager::TSnapMetadataFieldaMetaField,
TUint32aValue
)

Set the Metadata

ParameterDescription
aMetaFieldfield to be modified
aValuevalue to be set

SetNameL ( const TDesC & )

IMPORT_C voidSetNameL(const TDesC &aName)

Set the destination's name

SetProtectionL ( CMManager::TProtectionLevel )

IMPORT_C voidSetProtectionL(CMManager::TProtectionLevelaProtLevel)

Set the protection level of the destination.

ParameterDescription
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 RCmDestination & )

IMPORT_C TBooloperator!=(const RCmDestination &aDestination)const

checks if destinations are not the same

Since
S60 3.2
ParameterDescription
aDestinationthe destination being compared

Returns: ETrue if the destinations are different

operator= ( const RCmDestination & )

IMPORT_C RCmDestination &operator=(const RCmDestination &aCmDestination)

assignment operator

Since
S60 3.2

Returns: RCmDestination

operator== ( const RCmDestination & )

IMPORT_C TBooloperator==(const RCmDestination &aDestination)const

checks if destinations are the same

Since
S60 3.2
ParameterDescription
aDestinationthe destination being compared

Returns: ETrue if the destinations are the same