Collapse all Symbian^3 Application Developer Library

CPsmSettings Class Reference

class CPsmSettings : public CBase

PSM Client Settings API class

Allows clients to make power save mode settings changes during power save mode change.

psmclient.lib

Inherits from

CPsmSettings
- CBase

Public Member Functions
TInt	BackupAndGetSettings ( RConfigInfoArray &, const TUint32 )
TInt	BackupSettings ( RConfigInfoArray &, const TUint32 )
TInt	GetCurrentMode ( TInt &)
TInt	GetSettings ( RConfigInfoArray &, const TUint32 )
IMPORT_C CPsmSettings *	NewL ()
IMPORT_C CPsmSettings *	NewLC ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Member Functions Documentation

BackupAndGetSettings(RConfigInfoArray &, const TUint32)

TInt	BackupAndGetSettings	(	RConfigInfoArray &	aPsmConfigArray,
			const TUint32	aRepository
		)	[pure virtual]

Changes the values. Backups current settings and returns new settings for current PSM mode

Only those settings that exists in aPsmConfigArray are updated, there are no new settings added to array on completion.

Parameters

RConfigInfoArray & aPsmConfigArray	Contains current settings, on exit, contains updated settings
const TUint32 aRepository	Specific repository UID where these settings are in

BackupSettings(RConfigInfoArray &, const TUint32)

TInt	BackupSettings	(	RConfigInfoArray &	aPsmConfigArray,
			const TUint32	aRepository
		)	[pure virtual]

Backups settings that exists in aPsmConfigArray. Note that any existing config information with same config Id in aRepository is overriden with new values from aPsmConfigArray.

Parameters

RConfigInfoArray & aPsmConfigArray	Contains settings to store into backup
const TUint32 aRepository	Specific repository UID where these settings are in

GetCurrentMode(TInt &)

TInt

GetCurrentMode

(

TInt &

aMode

)

[pure virtual]

Gives currently active power save mode. If mode change is ongoing, gives the PSM mode for which is changing.

Parameters

TInt & aMode

Contains currently active power save mode on completion

GetSettings(RConfigInfoArray &, const TUint32)

TInt	GetSettings	(	RConfigInfoArray &	aPsmConfigArray,
			const TUint32	aRepository
		)	[pure virtual]

Gets configuration set for current mode without doing any backups. Only reads configurations for currently active power save mode. If current mode is not a power save mode, returns empty array.

Gets prefilled config array as a parameter, and only those settings that are in array are got, for example if there is three different settings for this repository and one wants to get only information which config Id is 2, only one config info with config Id 2 should exists in aParamConfigArray

Parameters

RConfigInfoArray & aPsmConfigArray	Prefilled config info array. Each prefilled config info must contain at least config Id
const TUint32 aRepository	Specific repository UID where these settings are in

NewL()

IMPORT_C CPsmSettings *

NewL

(

)

[static]

Creates a new PSM client.

NewLC()

IMPORT_C CPsmSettings *

NewLC

(

)

[static]