Collapse all Symbian^3 Application Developer Library

MProEngEngine Class Reference

class MProEngEngine

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

ProfileEngine.lib

Since: 3.1

Public Member Functions
	~MProEngEngine ()
TInt	ActiveProfileId ()
MProEngProfile *	ActiveProfileL ()
MProEngProfile *	ActiveProfileLC ()
MProEngProfile *	ProfileL ( TInt )
MProEngProfile *	ProfileLC ( TInt )
MProEngProfileNameArray *	ProfileNameArrayLC ()
void	Release ()
void	SetActiveProfileL ( TInt )

Private Member Functions
MProEngChangeObserverExt *	Extension ()

Constructor & Destructor Documentation

~MProEngEngine()

~MProEngEngine

(

)

[inline, virtual]

Member Functions Documentation

ActiveProfileId()

TInt

ActiveProfileId

(

)

[pure virtual]

Return active profile ID or system error code.

Since: 3.1

ActiveProfileL()

MProEngProfile *

ActiveProfileL

(

)

[pure virtual]

Return active profile, ownership transferred.

Since: 3.1

ActiveProfileLC()

MProEngProfile *

ActiveProfileLC

(

)

[pure virtual]

Return active profile, ownership transferred.

Since: 3.1

Extension()

MProEngChangeObserverExt *

Extension

(

)

[private, inline, virtual]

This member is internal and not intended for use.

ProfileL(TInt)

MProEngProfile *

ProfileL

(

TInt

aId

)

[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

Parameters

TInt aId

Profile ID

ProfileLC(TInt)

MProEngProfile *

ProfileLC

(

TInt

aId

)

[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

Parameters

TInt aId

Profile ID

ProfileNameArrayLC()

MProEngProfileNameArray *

ProfileNameArrayLC

(

)

[pure virtual]

Return profile name array, ownership transferred.

Since: 3.1

Release()

void

Release

(

)

[pure virtual]

Free resources of MProEngEngine .

Since: 3.1

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

Parameters

TInt aId

Profile ID