MProEngEngine Class Reference

API published in: S60 3rd Ed FP 1

Link against: profileengine.lib

Capability Information

Required Capabilities

WriteDeviceData

Exceptions

No capabilities needed for reading profiles.

#include <mproengengine.h>

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


Public Member Functions
virtual	~MProEngEngine ()
virtual void	Release ()=0
	Free resources of MProEngEngine.
virtual MProEngProfile *	ActiveProfileLC ()=0
	Return active profile, ownership transferred.
virtual MProEngProfile *	ActiveProfileL ()=0
	Return active profile, ownership transferred.
virtual TInt	ActiveProfileId ()=0
	Return active profile ID or system error code.
virtual MProEngProfileNameArray *	ProfileNameArrayLC ()=0
	Return profile name array, ownership transferred.
virtual void	SetActiveProfileL (TInt aId)=0
	Set the active profile, if ID is incorrect then leave with KErrNotFound.
virtual MProEngProfile *	ProfileLC (TInt aId)=0
	Return the settings of the profile with the given ID.
virtual MProEngProfile *	ProfileL (TInt aId)=0
	Return the settings of the profile with the given ID, the ownership of the created object is transferred.

Constructor & Destructor Documentation

virtual MProEngEngine::~MProEngEngine ( ) [inline, virtual]

Member Function Documentation

virtual TInt MProEngEngine::ActiveProfileId ( ) [pure virtual]

Return active profile ID or system error code.

Returns:: Active profile ID or system error code.

virtual MProEngProfile* MProEngEngine::ActiveProfileL ( ) [pure virtual]

Return active profile, ownership transferred.

Returns:: Instance of the MProfile

virtual MProEngProfile* MProEngEngine::ActiveProfileLC ( ) [pure virtual]

Return active profile, ownership transferred.

Returns:: Instance of the MProfile

virtual MProEngProfile* MProEngEngine::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.

Parameters:

aId

Profile ID

Returns:: Instance of the MProEngProfile

virtual MProEngProfile* MProEngEngine::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.

Parameters:

aId

Profile ID