Collapse all Symbian^3 Application Developer Library

RAccessoryMode Class Reference

class RAccessoryMode : public RAccessorySubsessionBase

Accessory Mode sub-session.

This class is not intended for user derivation.

AccClient.lib

Since: S60 3.1

Inherits from

RAccessoryMode
- RAccessorySubsessionBase
  - RSubSessionBase

Public Member Functions
	RAccessoryMode ()
IMPORT_C void	CancelGetAccessoryMode ()
IMPORT_C void	CancelNotifyAccessoryModeChanged ()
IMPORT_C TInt	CloseSubSession ()
IMPORT_C TInt	CreateSubSession ( RAccessoryServer &)
IMPORT_C TInt	GetAccessoryMode ( TAccPolAccessoryMode &)
IMPORT_C void	GetAccessoryMode ( TRequestStatus &, TAccPolAccessoryMode &)
IMPORT_C void	NotifyAccessoryModeChanged ( TRequestStatus &, TAccPolAccessoryMode &)

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

Private Attributes
TInt	iFlags
TPckg < TInt >	iFlagsPckg
TAccSrvAccessoryModePckg	iGetAccessoryModePckg
TAccSrvAccessoryModePckg	iNotifyAccessoryModeChangedPckg
TPckg < TInt >	iReserved1
TPckg < TInt >	iReserved2

Constructor & Destructor Documentation

RAccessoryMode()

IMPORT_C

RAccessoryMode

(

)

C++ default constructor.

Member Functions Documentation

CancelGetAccessoryMode()

IMPORT_C void

CancelGetAccessoryMode

(

)

const

Cancel GetAccessoryMode() .

Since: S60 3.1

CancelNotifyAccessoryModeChanged()

IMPORT_C void

CancelNotifyAccessoryModeChanged

(

)

const

Cancel NotifyAccessoryModeChanged() .

Since: S60 3.1

CloseSubSession()

IMPORT_C TInt

CloseSubSession

(

)

[virtual]

Closes the RAccessoryMode 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.

GetAccessoryMode(TAccPolAccessoryMode &)

IMPORT_C TInt

GetAccessoryMode

(

TAccPolAccessoryMode &

aAccessoryMode

)

const

Returns the current accessory mode.

Since: S60 3.1

Parameters

TAccPolAccessoryMode & aAccessoryMode

On return, contains the Accessory mode. TAccPolAccessoryMode is declared in AccPolAccessoryMode.h.

GetAccessoryMode(TRequestStatus &, TAccPolAccessoryMode &)

IMPORT_C void	GetAccessoryMode	(	TRequestStatus &	aStatus,
			TAccPolAccessoryMode &	aAccessoryMode
		)

Returns the current accessory mode.

Since: S60 3.1

Parameters

TRequestStatus & aStatus	Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
TAccPolAccessoryMode & aAccessoryMode	On successful request completion, contains the Accessory mode. TAccPolAccessoryMode is declared in AccPolAccessoryMode.h.

NotifyAccessoryModeChanged(TRequestStatus &, TAccPolAccessoryMode &)

IMPORT_C void	NotifyAccessoryModeChanged	(	TRequestStatus &	aStatus,
			TAccPolAccessoryMode &	aAccessoryMode
		)

Issues a request for accessory mode changed notification. Request must be renewed after completion if further notifications are needed.

Since: S60 3.1

Parameters

TRequestStatus & aStatus	Indicates the completion status of a request. KErrNone if successful, system-wide error code if failed. Specifically: KErrAlreadyExists, if request allready exist KErrCancel, if request is cancelled
TAccPolAccessoryMode & aAccessoryMode	On successful request completion, contains the updated Accessory Mode. TAccPolAccessoryMode is declared in AccPolAccessoryMode.h.