RCmManager 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 <cmmanager.h>

Detailed Description

RCmManager gives access to network destinations and connection methods.

Public Member Functions

 RCmManager ()
 Default constructor.
IMPORT_C void OpenL ()
 Symbian constructor.
IMPORT_C void OpenLC ()
 Symbian constructor Pushes the object on the cleanup stack.
IMPORT_C void Close ()
 Secondary destructor.
IMPORT_C TUint32 GetBearerInfoIntL (TUint32 aBearerType, TUint32 aAttribute) const
 Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.
IMPORT_C TBool GetBearerInfoBoolL (TUint32 aBearerType, TUint32 aAttribute) const
 Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.
IMPORT_C HBufC * GetBearerInfoStringL (TUint32 aBearerType, TUint32 aAttribute) const
 Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.
IMPORT_C HBufC8 * GetBearerInfoString8L (TUint32 aBearerType, TUint32 aAttribute) const
 Used to query bearer information that does not belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority, etc.
IMPORT_C TUint32 GetConnectionMethodInfoIntL (TUint32 aIapId, TUint32 aAttribute) const
 Used to query any non-bearer specific information about a given connection method.
IMPORT_C TBool GetConnectionMethodInfoBoolL (TUint32 aIapId, TUint32 aAttribute) const
 Used to query any, non-bearer specific information about a given connection method.
IMPORT_C HBufC * GetConnectionMethodInfoStringL (TUint32 aIapId, TUint32 aAttribute) const
 Used to query any non-bearer specific information about a given connection method.
IMPORT_C HBufC8 * GetConnectionMethodInfoString8L (TUint32 aIapId, TUint32 aAttribute) const
 Used to query any non-bearer specific information about a given connection method.
IMPORT_C RCmConnectionMethod ConnectionMethodL (TUint32 aConnectionMethodId) const
 Returns the connection method queried by its ID.
IMPORT_C void ConnectionMethodL (RArray< TUint32 > &aCMArray, TBool aCheckBearerType=ETrue, TBool aLegacyOnly=ETrue, TBool aEasyWlan=EFalse) const
 Returns the list of connection methods.
IMPORT_C void AllDestinationsL (RArray< TUint32 > &aDestArray) const
 Returns an array of all destination id's.
IMPORT_C RCmDestination DestinationL (TUint32 aDestinationId) const
 Returns the destination to which a specified connection method belongs, search is by destination ID.
IMPORT_C void BearerPriorityArrayL (RArray< TBearerPriority > &aArray) const
 Returns the copy of the bearer priority array.
IMPORT_C void CleanupGlobalPriorityArray (RArray< TBearerPriority > &aArray) const
 Clean up passed global bearer priority array.
IMPORT_C TUint32 EasyWlanIdL () const
 Returns the id of the EasyWlan connection method.
IMPORT_C void ReadDefConnL (TCmDefConnValue &aDCSetting)
 Returns the default connection method/SNAP.

Constructor & Destructor Documentation

RCmManager::RCmManager (   )  [inline]
 

Default constructor.

Member Function Documentation

IMPORT_C void RCmManager::AllDestinationsL ( RArray< TUint32 > &  aDestArray  )  const
 

Returns an array of all destination id's.

Parameters:
aDestArray list all available destinations' id
IMPORT_C void RCmManager::BearerPriorityArrayL ( RArray< TBearerPriority > &  aArray  )  const
 

Returns the copy of the bearer priority array.

Ownership is passed.

Parameters:
aArray bearer priority array
IMPORT_C void RCmManager::CleanupGlobalPriorityArray ( RArray< TBearerPriority > &  aArray  )  const
 

Clean up passed global bearer priority array.

Delete the elements and calls Reset and Close on the array.

Parameters:
aArray array to be cleaned up
IMPORT_C void RCmManager::Close (   ) 
 

Secondary destructor.

IMPORT_C void RCmManager::ConnectionMethodL ( RArray< TUint32 > &  aCMArray,
TBool  aCheckBearerType = ETrue,
TBool  aLegacyOnly = ETrue,
TBool  aEasyWlan = EFalse
)  const
 

Returns the list of connection methods.

Connection Methods are filtered by the switch parameters e.g. aLegacyOnly.

Parameters:
aCMArray on return it is the array of IAP ids.
aCheckBearerType If ETrue only connection methods with supported bearer type are returned
aLegacyOnly when set to ETrue only Legacy IAP ids will be returned
aEasyWlan when set to ETrue EasyWlan id is returned, too
IMPORT_C RCmConnectionMethod RCmManager::ConnectionMethodL ( TUint32  aConnectionMethodId  )  const
 

Returns the connection method queried by its ID.

Parameters:
aConnectionMethodId id of the connection method
Returns:
RCmConnectionMethod connection method
IMPORT_C RCmDestination RCmManager::DestinationL ( TUint32  aDestinationId  )  const
 

Returns the destination to which a specified connection method belongs, search is by destination ID.

Parameters:
aDestinationId id of destination
Returns:
RCmDestination network destination
IMPORT_C TUint32 RCmManager::EasyWlanIdL (   )  const
 

Returns the id of the EasyWlan connection method.

Returns:
id of the EasyWLan connection method. 0 if not found.
IMPORT_C TBool RCmManager::GetBearerInfoBoolL ( TUint32  aBearerType,
TUint32  aAttribute
)  const
 

Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.

Parameters:
aBearerType the bearer
aAttribute the setting value
Returns:
the setting value
IMPORT_C TUint32 RCmManager::GetBearerInfoIntL ( TUint32  aBearerType,
TUint32  aAttribute
)  const
 

Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.

Parameters:
aBearerType the bearer
aAttribute the setting value
Returns:
the setting value
IMPORT_C HBufC8* RCmManager::GetBearerInfoString8L ( TUint32  aBearerType,
TUint32  aAttribute
)  const
 

Used to query bearer information that does not belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority, etc.

HBuf ownership is passed to the caller

Parameters:
aBearerType the bearer
aAttribute the setting value
Returns:
the setting value
IMPORT_C HBufC* RCmManager::GetBearerInfoStringL ( TUint32  aBearerType,
TUint32  aAttribute
)  const
 

Used to query bearer information that doesn't belong to a specific connection method, such as ECmCoverage or ECmDefaultPriority etc.

HBuf ownership is passed to the caller

Parameters:
aBearerType the bearer
aAttribute the setting value
Returns:
the setting value
IMPORT_C TBool RCmManager::GetConnectionMethodInfoBoolL ( TUint32  aIapId,
TUint32  aAttribute
)  const
 

Used to query any, non-bearer specific information about a given connection method.

This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc.

Parameters:
aIapId the connection method id
aAttribute the setting value
Returns:
the setting value
IMPORT_C TUint32 RCmManager::GetConnectionMethodInfoIntL ( TUint32  aIapId,
TUint32  aAttribute
)  const
 

Used to query any non-bearer specific information about a given connection method.

This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc.

Parameters:
aIapId the connection method id
aAttribute the setting value
Returns:
the setting value
IMPORT_C HBufC8* RCmManager::GetConnectionMethodInfoString8L ( TUint32  aIapId,
TUint32  aAttribute
)  const
 

Used to query any non-bearer specific information about a given connection method.

This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc. HBuf ownership is passed to the caller

Parameters:
aIapId the connection method id
aAttribute the setting value
Returns:
the setting value
IMPORT_C HBufC* RCmManager::GetConnectionMethodInfoStringL ( TUint32  aIapId,
TUint32  aAttribute
)  const
 

Used to query any non-bearer specific information about a given connection method.

This can be e.g. ECmBearerType, ECmName, ECmStartPage, etc. HBuf ownership is passed to the caller

Parameters:
aIapId the connection method id
aAttribute the setting value
Returns:
the setting value
IMPORT_C void RCmManager::OpenL (   ) 
 

Symbian constructor.

IMPORT_C void RCmManager::OpenLC (   ) 
 

Symbian constructor Pushes the object on the cleanup stack.

IMPORT_C void RCmManager::ReadDefConnL ( TCmDefConnValue &  aDCSetting  ) 
 

Returns the default connection method/SNAP.

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