RCmConnectionMethod 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 <cmconnectionmethod.h>

Detailed Description

RCmConnectionMethod is for getting values of a connection method.

Public Member Functions
IMPORT_C  RCmConnectionMethod ()
  Default constructor.
IMPORT_C  RCmConnectionMethod (const RCmConnectionMethod &aItem)
  Copy constructor.
IMPORT_C  ~RCmConnectionMethod ()
  Destructor.
IMPORT_C void  Close ()
  Close the session.
IMPORT_C TUint32  GetIntAttributeL (TUint32 aAttribute) const
  Gets the value for a TInt attribute.
IMPORT_C TBool  GetBoolAttributeL (TUint32 aAttribute) const
  Gets the value for a TBool attribute.
IMPORT_C HBufC *  GetStringAttributeL (TUint32 aAttribute) const
  Gets the value for a String16 attribute.
IMPORT_C HBufC8 *  GetString8AttributeL (const TUint32 aAttribute) const
  Gets the value for a String8 attribute.
IMPORT_C RCmDestination  DestinationL () const
  Call this function only if this CM is an embedded destination!
IMPORT_C TBool  operator== (RCmConnectionMethod &aConnMethod) const
  checks if connection methods are the same
IMPORT_C TBool  operator!= (RCmConnectionMethod &aConnMethod) const
  checks if connection methods are not the same
IMPORT_C RCmConnectionMethod &  operator= (const RCmConnectionMethod &aConnMethod)
  assignment operator

Friends
class  RCmDestination
class  RCmManager

Constructor & Destructor Documentation

IMPORT_C RCmConnectionMethod::RCmConnectionMethod (   ) 
 

Default constructor.

IMPORT_C RCmConnectionMethod::RCmConnectionMethod (  const RCmConnectionMethod &  aItem  ) 
 

Copy constructor.

IMPORT_C RCmConnectionMethod::~RCmConnectionMethod (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C void RCmConnectionMethod::Close (   ) 
 

Close the session.

IMPORT_C RCmDestination RCmConnectionMethod::DestinationL (   )  const
 

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

Returns:
embedded destination
IMPORT_C TBool RCmConnectionMethod::GetBoolAttributeL (  TUint32  aAttribute  )  const
 

Gets the value for a TBool attribute.

Parameters:
aAttribute  Identifies the attribute to be retrieved.
Returns:
contains the requested TBool attribute.
IMPORT_C TUint32 RCmConnectionMethod::GetIntAttributeL (  TUint32  aAttribute  )  const
 

Gets the value for a TInt attribute.

Parameters:
aAttribute  Identifies the attribute to be retrieved.
Returns:
contains the requested TInt attribute.
IMPORT_C HBufC8* RCmConnectionMethod::GetString8AttributeL (  const TUint32  aAttribute  )  const
 

Gets the value for a String8 attribute.

HBuf ownership is passed to the caller

Parameters:
aAttribute  Identifies the attribute to be retrieved.
Returns:
copy of the requested attribute. Ownership is passed.
IMPORT_C HBufC* RCmConnectionMethod::GetStringAttributeL (  TUint32  aAttribute  )  const
 

Gets the value for a String16 attribute.

HBuf ownership is passed to the caller

Parameters:
aAttribute  Identifies the attribute to be retrieved.
Returns:
copy of the requested attribute. Ownership is passed.
IMPORT_C TBool RCmConnectionMethod::operator!= (  RCmConnectionMethod &  aConnMethod  )  const
 

checks if connection methods are not the same

Parameters:
aConnMethod  the connection method being compared
Returns:
ETrue if the destinations are different
IMPORT_C RCmConnectionMethod& RCmConnectionMethod::operator= (  const RCmConnectionMethod &  aConnMethod  ) 
 

assignment operator

Returns:
RCmConnectionMethod
IMPORT_C TBool RCmConnectionMethod::operator== (  RCmConnectionMethod &  aConnMethod  )  const
 

checks if connection methods are the same

Parameters:
aConnMethod  the connection method being compared
Returns:
ETrue if the destinations are the same

Friends And Related Function Documentation

friend class RCmDestination [friend]
 
friend class RCmManager [friend]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top