RCmConnectionMethod Class Reference

#include <mw/cmconnectionmethod.h>

Link against: cmmanager.lib

class RCmConnectionMethod

Public Member Functions
	RCmConnectionMethod()
	RCmConnectionMethod(const RCmConnectionMethod &)
	~RCmConnectionMethod()
IMPORT_C void	Close()
IMPORT_C RCmConnectionMethod	CreateCopyL()
IMPORT_C TBool	DeleteL()
IMPORT_C RCmDestination	DestinationL()
IMPORT_C TBool	GetBoolAttributeL(TUint32)
IMPORT_C TUint32	GetIntAttributeL(TUint32)
IMPORT_C HBufC8 *	GetString8AttributeL(const TUint32)
IMPORT_C HBufC *	GetStringAttributeL(TUint32)
IMPORT_C void	SetBoolAttributeL(TUint32, TBool)
IMPORT_C void	SetIntAttributeL(TUint32, TUint32)
IMPORT_C void	SetString8AttributeL(TUint32, const TDesC8 &)
IMPORT_C void	SetStringAttributeL(TUint32, const TDesC16 &)
IMPORT_C void	UpdateL()
IMPORT_C TBool	operator!=(RCmConnectionMethod &)
IMPORT_C RCmConnectionMethod &	operator=(const RCmConnectionMethod &)
IMPORT_C TBool	operator==(RCmConnectionMethod &)

Detailed Description

RCmConnectionMethod is for getting/setting values of a connection method.

Since: S60 v3.2

Constructor & Destructor Documentation

RCmConnectionMethod ( )

IMPORT_C

RCmConnectionMethod

(

)

Default constructor.

RCmConnectionMethod ( const RCmConnectionMethod & )

IMPORT_C

RCmConnectionMethod

(

const RCmConnectionMethod &

aItem

)

Copy constructor.

~RCmConnectionMethod ( )

IMPORT_C

~RCmConnectionMethod

(

)

Destructor.

Member Function Documentation

Close ( )

IMPORT_C void

(

)

Close the session

Since: S60 3.2

CreateCopyL ( )

IMPORT_C RCmConnectionMethod

CreateCopyL

(

)

Creates a copy of this connection method. UpdateL() has to be called to store new connection method in database. Ownership is passed.

DeleteL ( )

IMPORT_C TBool

DeleteL

(

)

Try to delete the connection method. If it is referenced from any destination, then the references are removed and the connection method is deleted. Do NOT call this function if you got this connection method from a destination. Call destination's DeleteConnectionMethodL() function instead.

Returns: ETrue if connection method deleted.

DestinationL ( )

IMPORT_C RCmDestination

DestinationL

(

)

const

Call this function only if this CM is an embedded destination!

Since: S60 3.2

Returns: embedded destination

GetBoolAttributeL ( TUint32 )

IMPORT_C TBool

GetBoolAttributeL

(

TUint32

aAttribute

)

const

Gets the value for a TBool attribute.

Since: S60 3.2

Parameter	Description
aAttribute	Identifies the attribute to be retrieved.

Returns: contains the requested TBool attribute.

GetIntAttributeL ( TUint32 )

IMPORT_C TUint32

GetIntAttributeL

(

TUint32

aAttribute

)

const

Gets the value for a TInt attribute.

Since: S60 3.2

Parameter	Description
aAttribute	Identifies the attribute to be retrieved.

Returns: contains the requested TInt attribute.

GetString8AttributeL ( const TUint32 )

IMPORT_C HBufC8 *

GetString8AttributeL

(

const TUint32

aAttribute

)

const

Gets the value for a String8 attribute. HBuf ownership is passed to the caller

Since: S60 3.2

Parameter	Description
aAttribute	Identifies the attribute to be retrieved.

Returns: copy of the requested attribute. Ownership is passed.

GetStringAttributeL ( TUint32 )

IMPORT_C HBufC *

GetStringAttributeL

(

TUint32

aAttribute

)

const

Gets the value for a String16 attribute. HBuf ownership is passed to the caller

Since: S60 3.2

Parameter	Description
aAttribute	Identifies the attribute to be retrieved.

Returns: copy of the requested attribute. Ownership is passed.

SetBoolAttributeL ( TUint32, TBool )

IMPORT_C void	SetBoolAttributeL	(	TUint32	aAttribute,
			TBool	aValue
		)

Sets the value for a TBool attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetIntAttributeL ( TUint32, TUint32 )

IMPORT_C void	SetIntAttributeL	(	TUint32	aAttribute,
			TUint32	aValue
		)

Sets the value for a TInt attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetString8AttributeL ( TUint32, const TDesC8 & )

IMPORT_C void	SetString8AttributeL	(	TUint32	aAttribute,
			const TDesC8 &	aValue
		)

Sets the value for a String8 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

SetStringAttributeL ( TUint32, const TDesC16 & )

IMPORT_C void	SetStringAttributeL	(	TUint32	aAttribute,
			const TDesC16 &	aValue
		)

Sets the value for a String16 attribute.

Parameter	Description
aAttribute	Identifies the attribute to be set.
aValue	The value to be set.

Returns: None.

UpdateL ( )

IMPORT_C void

UpdateL

(

)

Update in the database.

Returns: None.

operator!= ( RCmConnectionMethod & )

IMPORT_C TBool

operator!=

(

RCmConnectionMethod &

aConnMethod

)

const

checks if connection methods are not the same

Since: S60 3.2

Parameter	Description
aConnMethod	the connection method being compared

Returns: ETrue if the destinations are different

operator= ( const RCmConnectionMethod & )

IMPORT_C RCmConnectionMethod &

operator=

(

const RCmConnectionMethod &

aConnMethod

)

assignment operator

Since: S60 3.2

Returns: RCmConnectionMethod

operator== ( RCmConnectionMethod & )

IMPORT_C TBool

operator==

(

RCmConnectionMethod &

aConnMethod

)

const

checks if connection methods are the same

Since: S60 3.2

Parameter	Description
aConnMethod	the connection method being compared

Returns: ETrue if the destinations are the same