MProEngEngine Class Reference

#include <mw/MProEngEngine.h>

Link against: ProfileEngine.lib

class MProEngEngine
Public Member Functions
virtual ~MProEngEngine()
pure virtual TInt ActiveProfileId()
pure virtual MProEngProfile *ActiveProfileL()
pure virtual MProEngProfile *ActiveProfileLC()
pure virtual MProEngProfile *ProfileL(TInt)
pure virtual MProEngProfile *ProfileLC(TInt)
pure virtual MProEngProfileNameArray *ProfileNameArrayLC()
pure virtual voidRelease()
pure virtual voidSetActiveProfileL(TInt)

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 );
Since
3.1

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 ( )

MProEngProfile *ActiveProfileL()[pure virtual]
Return active profile, ownership transferred.
Since
3.1

Returns: Instance of the MProfile

ActiveProfileLC ( )

MProEngProfile *ActiveProfileLC()[pure virtual]
Return active profile, ownership transferred.
Since
3.1

Returns: Instance of the MProfile

ProfileL ( TInt )

MProEngProfile *ProfileL(TIntaId)[pure virtual]
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
ParameterDescription
aIdProfile ID

Returns: Instance of the MProEngProfile

ProfileLC ( TInt )

MProEngProfile *ProfileLC(TIntaId)[pure virtual]
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
ParameterDescription
aIdProfile ID

Returns: Instance of the MProEngProfile

ProfileNameArrayLC ( )

MProEngProfileNameArray *ProfileNameArrayLC()[pure virtual]
Return profile name array, ownership transferred.
Since
3.1

Returns: Instance of the profile name array

Release ( )

voidRelease()[pure virtual]
Free resources of MProEngEngine.
Since
3.1

SetActiveProfileL ( TInt )

voidSetActiveProfileL(TIntaId)[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
ParameterDescription
aIdProfile ID
© Nokia 2011.