Collapse all Symbian^3 Application Developer Library

MPsmSettingsProvider Class Reference

class MPsmSettingsProvider

PSM Settings Provider class for PSM plug-ins settings

Public Member Functions
void	BackupAndGetSettingsL ( RConfigInfoArray &, const TUint32 )
void	BackupSettingsL (const RConfigInfoArray &, const TUint32 )
void	GetSettingsL ( RConfigInfoArray &, const TUint32 )
TPsmsrvMode	Mode ()

Member Functions Documentation

BackupAndGetSettingsL(RConfigInfoArray &, const TUint32)

void	BackupAndGetSettingsL	(	RConfigInfoArray &	aPsmConfigArray,
			const TUint32	aRepository
		)	[pure virtual]

Changes the values. Backups current settings and returns changed settings. Plug-ins should give same settings set no matter what the mode is. PSM server takes care of setting correct values back to parameter aPsmConfigArray.

leave: KErrNotFound if no settings are found for this plugin

Parameters

RConfigInfoArray & aPsmConfigArray	Contains current settings, on exit, contains updated settings
const TUint32 aRepository	Specific reposiroty UID where these settings are in. Identifies the configuration file located in PSM servers private folder

BackupSettingsL(const RConfigInfoArray &, const TUint32)

void	BackupSettingsL	(	const 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.

leave: KErrWrite if device is not in any power save mode, a system wide error code

Parameters

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

GetSettingsL(RConfigInfoArray &, const TUint32)

void	GetSettingsL	(	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 settings from backup storage.

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 reposiroty UID where these settings are in

Mode()

TPsmsrvMode

Mode

(

)

[pure virtual]

Current mode where to switch to.