RCmDestination Class Reference

API published in: S60 3rd Ed FP 2

Link against: cmmanager.lib

Capability Information

Required Capabilities

None

Exceptions

Reading 'private' user data such as user names or passwords: ReadDeviceData

#include <cmdestination.h>

Detailed Description

RCmDestination is for getting values of a network destination.


Public Member Functions
IMPORT_C	RCmDestination ()
	Default constructor.
IMPORT_C	~RCmDestination ()
IMPORT_C	RCmDestination (const RCmDestination &aCmDestination)
IMPORT_C void	Close ()
	Close the session.
IMPORT_C TInt	ConnectionMethodCount () const
	Returns the number of connection methods of the destination.
IMPORT_C RCmConnectionMethod	ConnectionMethodL (TInt anIndex) const
	Returns a reference to the connection method.
IMPORT_C RCmConnectionMethod	ConnectionMethodByIDL (TInt aCmId) const
	Returns the connection method with the ECmId.
IMPORT_C TUint	PriorityL (const RCmConnectionMethod &aCCMItem) const
	Return the priority of the passed connection method.
IMPORT_C HBufC *	NameLC () const
	Returns the destination's Name attribute HBuf ownership is passed to the caller.
IMPORT_C TUint32	Id () const
	Returns the destination's Id attribute.
IMPORT_C TUint32	ElementId () const
	Returns the destination's ElementId attribute.
IMPORT_C CGulIcon *	IconL () const
	Returns the Icon pointer This function leaves if the client does not have a valid UI context.
IMPORT_C TUint32	MetadataL (CMManager::TSnapMetadataField aMetaField) const
	Returns the Metadata.
IMPORT_C CMManager::TProtectionLevel	ProtectionLevel () const
	Return the protection level of the destination.
IMPORT_C TBool	IsConnectedL () const
	Returns if there's a connection created with any of the destination's connection method.
IMPORT_C TBool	IsHidden () const
	Returns whether the destination is hidden or not.
IMPORT_C TBool	operator== (const RCmDestination &aDestination) const
	checks if destinations are the same
IMPORT_C TBool	operator!= (const RCmDestination &aDestination) const
	checks if destinations are not the same
IMPORT_C RCmDestination &	operator= (const RCmDestination &aCmDestination)
	assignment operator
Friends
class	RCmManager
class	RCmConnectionMethod

Constructor & Destructor Documentation

IMPORT_C RCmDestination::RCmDestination

Default constructor.

IMPORT_C RCmDestination::~RCmDestination

IMPORT_C RCmDestination::RCmDestination

const RCmDestination &

aCmDestination

Member Function Documentation

IMPORT_C void RCmDestination::Close

Close the session.

IMPORT_C RCmConnectionMethod RCmDestination::ConnectionMethodByIDL

Returns the connection method with the ECmId.

Leaves with KErrNotFound if not found.

Parameters:

unique id of the requested connection method.

Returns:: connection method

IMPORT_C TInt RCmDestination::ConnectionMethodCount

Returns the number of connection methods of the destination.

Returns:: the number of connection methods belonging to a destination

IMPORT_C RCmConnectionMethod RCmDestination::ConnectionMethodL

Returns a reference to the connection method.

The index must be less than the return value of ConnectionMethodCount().

Parameters:

Returns:: a connection method

IMPORT_C TUint32 RCmDestination::ElementId

Returns the destination's ElementId attribute.

Returns:: the destination's element id

IMPORT_C CGulIcon* RCmDestination::IconL

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

Returns:: the destination icon

IMPORT_C TUint32 RCmDestination::Id

Returns the destination's Id attribute.

Returns:: the destination's id

IMPORT_C TBool RCmDestination::IsConnectedL

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

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

IMPORT_C TBool RCmDestination::IsHidden

Returns whether the destination is hidden or not.

Returns:: ETrue if the destination is hidden

IMPORT_C TUint32 RCmDestination::MetadataL

CMManager::TSnapMetadataField

Returns the Metadata.

Parameters:

the meta data field to query

Returns:: the value of the requested field

IMPORT_C HBufC* RCmDestination::NameLC

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

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

IMPORT_C TBool RCmDestination::operator!=

const RCmDestination &

checks if destinations are not the same

Parameters:

the destination being compared

Returns:: ETrue if the destinations are different

IMPORT_C RCmDestination& RCmDestination::operator=

const RCmDestination &

aCmDestination

assignment operator

Parameters:

the destination being compared

Returns:: RCmDestination

IMPORT_C TBool RCmDestination::operator==

const RCmDestination &

checks if destinations are the same

Parameters:

the destination being compared

Returns:: ETrue if the destinations are the same

IMPORT_C TUint RCmDestination::PriorityL

const RCmConnectionMethod &

Return the priority of the passed connection method.

Parameters:

connection method

Returns:: the priority of the queried connection method

IMPORT_C CMManager::TProtectionLevel RCmDestination::ProtectionLevel

Return the protection level of the destination.

Returns:: protection level of the destination

Friends And Related Function Documentation

friend class RCmConnectionMethod [friend]

friend class RCmManager [friend]

The documentation for this class was generated from the following file:

cmdestination.h

Copyright © Nokia Corporation 2001-2008