Collapse all Symbian^3 Application Developer Library

RAccessorySettings Class Reference

class RAccessorySettings : public RAccessorySubsessionBase

Accessory Settings sub-session. Accessory Settings provides methods for changing and checking status of accessory related settings.

This class is not intended for user derivation.

AccClient.lib

Since: S60 3.1

Inherits from

RAccessorySettings
- RAccessorySubsessionBase
  - RSubSessionBase

Public Member Functions
	RAccessorySettings ()
IMPORT_C TInt	CloseSubSession ()
IMPORT_C TInt	CreateSubSession ( RAccessoryServer &)
IMPORT_C TInt	GetAccessoryModeSetting (const TAccMode , TAccModeSetting &)
IMPORT_C TInt	GetAccessoryModeSettings (const TAccMode , TAccModeSettingArray &)
IMPORT_C TInt	GetHWDeviceSettings ( TUint32 &)
IMPORT_C TInt	GetSupportedHWDeviceSettings ( TUint32 &)
IMPORT_C TInt	SetAccessoryModeSettingL (const TAccMode , TAccModeSetting &)
IMPORT_C TInt	SetAccessoryModeSettingsL (const TAccMode , TAccModeSettingArray &)
IMPORT_C TInt	SetHWDeviceSettingsL ( TUint32 , TBool , TBool )

Inherited Functions
	RAccessorySubsessionBase::RAccessorySubsessionBase()
	RSubSessionBase::CloseSubSession(TInt)
	RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
	RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
	RSubSessionBase::RSubSessionBase()
	RSubSessionBase::Send(TInt)const
	RSubSessionBase::Send(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt)const
	RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSubSessionBase::Session()const
	RSubSessionBase::SubSessionHandle()const

Constructor & Destructor Documentation

RAccessorySettings()

IMPORT_C

RAccessorySettings

(

)

C++ default constructor.

Member Functions Documentation

CloseSubSession()

IMPORT_C TInt

CloseSubSession

(

)

[virtual]

Closes the RAccessorySettings sub-session.

Since: S60 3.1

CreateSubSession()

CreateSubSession(RAccessoryServer &)

IMPORT_C TInt

CreateSubSession

(

RAccessoryServer &

aSession

)

[virtual]

Creates a new sub-session within an existing session.

Since: S60 3.1

Parameters

RAccessoryServer & aSession

The session to which this sub-session will belong.

GetAccessoryModeSetting(const TAccMode, TAccModeSetting &)

IMPORT_C TInt	GetAccessoryModeSetting	(	const TAccMode	aAccMode,
			TAccModeSetting &	aSetting
		)	const

Returns one setting for specified accessory mode.

Since: S60 3.1

Parameters

const TAccMode aAccMode	Defines an accessory mode. Parameter has to be set before calling this method.
TAccModeSetting & aSetting	Defines setting and it's value. Identification of setting has to be set to aSetting before calling this method.

GetAccessoryModeSettings(const TAccMode, TAccModeSettingArray &)

IMPORT_C TInt	GetAccessoryModeSettings	(	const TAccMode	aAccMode,
			TAccModeSettingArray &	aArray
		)	const

Returns all settings for specified accessory mode.

Since: S60 3.1

Parameters

const TAccMode aAccMode	Defines accessory mode. Parameter has to be set before calling this method.
TAccModeSettingArray & aArray	On return contains all existing settings for accessory mode.

GetHWDeviceSettings(TUint32 &)

IMPORT_C TInt

GetHWDeviceSettings

(

TUint32 &

aSettings

)

const

Returns current HW devices.

Since: S60 3.1

Parameters

TUint32 & aSettings

Bit mask storing one or several HW devices. At the moment only one setting is supported. See AccessoryTypes.h for HW device bit mask definitions.

GetSupportedHWDeviceSettings(TUint32 &)

IMPORT_C TInt

GetSupportedHWDeviceSettings

(

TUint32 &

aSettings

)

Returns HW devices that can't be properly identified when they are connected to phone without additional information.

Since: S60 3.1

Parameters

TUint32 & aSettings

Bit mask storing one or several HW devices. See AccessoryTypes.h for HW device bit mask definitions.

SetAccessoryModeSettingL(const TAccMode, TAccModeSetting &)

IMPORT_C TInt	SetAccessoryModeSettingL	(	const TAccMode	aAccMode,
			TAccModeSetting &	aSetting
		)

Sets one setting for specified accessory mode.

For example: When accessory mode is EAccModeWiredCarKit and settings id is KAccServerWiredCarKitLights then setting value must be type of enum TAccLightSettings.

Since: S60 3.1

Exceptions

system-wide

error code if failed.

Parameters

const TAccMode aAccMode	Defines an accessory mode. Parameter has to be set before calling this method.
TAccModeSetting & aSetting	Defines setting and it's value. Fill in identification number and TInt, TBool or TDes type setting before calling this method. For details on how to fill in TAccModeSetting object see AccModeSetting.h.

SetAccessoryModeSettingsL(const TAccMode, TAccModeSettingArray &)

IMPORT_C TInt	SetAccessoryModeSettingsL	(	const TAccMode	aAccMode,
			TAccModeSettingArray &	aArray
		)

Sets several settings for specified accessory mode.

Since: S60 3.1

Exceptions

system-wide

error code if failed.

Parameters

const TAccMode aAccMode	Defines an accessory mode. Parameter has to be set before calling this method.
TAccModeSettingArray & aArray	Defines an array of several setting and value pairs. See AccModeSettingArray.h on how to add TAccModeSetting objects to array. For each TAccModeSetting object fill in identification number and TInt, TBool or TDes type setting. For details on how to fill in TAccModeSetting object see AccModeSetting.h.

SetHWDeviceSettingsL(TUint32, TBool, TBool)

IMPORT_C TInt	SetHWDeviceSettingsL	(	TUint32	aSettings,
			TBool	aEnable = ETrue,
			TBool	aForce = EFalse
		)

Sets or removes HW devices. Used to identify HW device properly when it's connected to phone.

Since: S60 3.1

Exceptions

system-wide

error code if failed.

Parameters

TUint32 aSettings	Bit mask storing one or several HW devices. At the moment only one setting is supported. New setting overrides possible current setting. See AccessoryTypes.h for HW device bit mask definitions.
TBool aEnable = ETrue	ETrue: sets HW device. EFalse: removes HW device.
TBool aForce = EFalse	Reserved for future use.