MProEngEngine Class Reference
#include
<mw/MProEngEngine.h>
Link against: ProfileEngine.lib
Detailed Description
Profile engine interface. This class offers methods to get active profile, active profile ID, profile names array and set active profile. How to use:
// Create profile engine by using Factory:
MProEngEngine* profileEngine = NewEngineL();
// Free resources with MProEngEngine::Release();
profileEngine->Release();
// or if you release resources in destructor:
if( iEngine )
{
iEngine->Release();
}
// If you put this class to CleanupStack then use void CleanupReleasePushL()
CleanupReleasePushL( *profileEngine );
Constructor & Destructor Documentation
~MProEngEngine ( )
| ~MProEngEngine | ( | ) | [inline, virtual] |
Member Function Documentation
ActiveProfileId ( )
|
TInt
| ActiveProfileId | ( | ) | [pure virtual] |
Return active profile ID or system error code.
- Since
- 3.1
Returns: Active profile ID or system error code.
ActiveProfileL ( )
Return active profile, ownership transferred.
- Since
- 3.1
Returns: Instance of the MProfile
ActiveProfileLC ( )
Return active profile, ownership transferred.
- Since
- 3.1
Returns: Instance of the MProfile
ProfileL ( TInt )
Return the settings of the profile with the given ID, the ownership of the created object is transferred. Leave with KErrNotFound if a profile with the given ID can not be found.
- Since
- 3.1
| Parameter | Description | | aId | Profile ID |
Returns: Instance of the MProEngProfile
ProfileLC ( TInt )
Return the settings of the profile with the given ID. The created object is pushed in the cleanup stack and the ownership is transferred. Leave with KErrNotFound if a profile with the given ID can not be found.
- Since
- 3.1
| Parameter | Description | | aId | Profile ID |
Returns: Instance of the MProEngProfile
ProfileNameArrayLC ( )
Return profile name array, ownership transferred.
- Since
- 3.1
Returns: Instance of the profile name array
Release ( )
| void | Release | ( | ) | [pure virtual] |
SetActiveProfileL ( TInt )
| void | SetActiveProfileL | ( | TInt | aId | ) | [pure virtual] |
Set the active profile, if ID is incorrect then leave with KErrNotFound. This method can be called only by processes having WriteDeviceData capability.
- Since
- 3.1
| Parameter | Description | | aId | Profile ID |