Collapse all Symbian^3 Product Developer Library

RSsmMiscAdaptation Class Reference

class RSsmMiscAdaptation : public RSsmAdaptationBase

Client interface for Miscellaneous Adaptation part of the Adaptation server.

Inherits from

RSsmMiscAdaptation
- RSsmAdaptationBase
  - RSessionBase
    - RHandleBase

Public Member Functions
IMPORT_C void	Cancel()
IMPORT_C void	GetGlobalStartupMode(TDes8 &, TRequestStatus &)
IMPORT_C void	GetHiddenReset(TDes8 &, TRequestStatus &)
IMPORT_C void	PrepareSimLanguages(TSsmLanguageListPriority, TDes8 &, TRequestStatus &)
IMPORT_C void	SecurityStateChange(TInt, TDes8 &, TRequestStatus &)
IMPORT_C CArrayFix< TInt32 > *	SimLanguagesArrayL(TInt)

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()
	RSsmAdaptationBase::Connect()
	RSsmAdaptationBase::Connect(TInt)

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Attributes
	RHandleBase::iHandle

Member Functions Documentation

Cancel()

IMPORT_C void

Cancel

(

)

Cancels the current outstanding request on this R class.

If the request is successfully cancelled then the TRequestStatus associated with that request will be completed with KErrCancel.

GetGlobalStartupMode(TDes8 &, TRequestStatus &)

IMPORT_C void	GetGlobalStartupMode	(	TDes8 &	aModePckg,
			TRequestStatus &	aRequest
		)

Retrieves the startup mode from the adaptation.

Note:

This API can only be called by processes with the SecureID of the System State Manager.

Parameters

TDes8 & aModePckg	A descriptor packaging a TInt object, such as TPckg<TInt>. The descriptor referenced should exist until aStatus is completed. When aStatus is completed with KErrNone this descriptor will contain the startup mode. The meaning of this startup mode value is dependent on the adaptation.
TRequestStatus & aRequest	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current process does not have the SecureID of the System State Manager, otherwise one of the other system-wide error codes.

GetHiddenReset(TDes8 &, TRequestStatus &)

IMPORT_C void	GetHiddenReset	(	TDes8 &	aHiddenResetPckg,
			TRequestStatus &	aStatus
		)

Retrieve information about Hidden reset.

Note:

This API can only be called by processes with the SecureID of the System State Manager.

Parameters

TDes8 & aHiddenResetPckg	A descriptor packaging a TBool object, such as TPckg<TBool>. The descriptor referenced should exist until aStatus is completed. When aStatus is completed with KErrNone this descriptor will contain ETrue if Hidden reset is to be done , EFalse otherwise.
TRequestStatus & aStatus	The request status. This is set to KErrNone on successful completion, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current process does not have the SecureID of the System State Manager, KErrDisconnected if there is no handle to adaptation server, otherwise one of the other system-wide error codes.

PrepareSimLanguages(TSsmLanguageListPriority, TDes8 &, TRequestStatus &)

IMPORT_C void	PrepareSimLanguages	(	TSsmLanguageListPriority	aPriority,
			TDes8 &	aSizePckg,
			TRequestStatus &	aStatus
		)

Prepares the SIM languages list for retrieval.

Note:

This API can only be called by processes with the SecureID of the System State Manager.

RSsmMiscAdaptation::SimLanguagesArrayL()

Parameters

TSsmLanguageListPriority aPriority	Specifies which languages list should be prepared for retrieval.
TDes8 & aSizePckg	A descriptor packaging a TInt object, such as TPckg<TInt>. The descriptor referenced should exist until aStatus is completed. When aStatus is completed with KErrNone this descriptor will contain the number of elements in the language list.
TRequestStatus & aStatus	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current process does not have the SecureID of the System State Manager, otherwise one of the other system-wide error codes.

SecurityStateChange(TInt, TDes8 &, TRequestStatus &)

IMPORT_C void	SecurityStateChange	(	TInt	aState,
			TDes8 &	aResponsePckg,
			TRequestStatus &	aStatus
		)

Communicates a security state change with the adaptation.

Note:

This API can only be called by processes with the SecureID of the System State Manager.

Parameters

TInt aState	The security state that has been changed to by the security state machine. The meaning of this value is dependent on the adaptation.
TDes8 & aResponsePckg	A descriptor packaging a TInt object, such as TPckg<TInt>. The descriptor referenced should exist until aStatus is completed. This descriptor will contain the response from the adaptation to this security state change. The meaning of this value is dependent on the adaptation.
TRequestStatus & aStatus	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current process does not have the SecureID of the System State Manager, otherwise one of the other system-wide error codes.

SimLanguagesArrayL(TInt)

IMPORT_C CArrayFix< TInt32 > *

SimLanguagesArrayL

(

TInt

aSimLanguageCount

)

Retrieves the SIM lanugages list.

This will retrieve the SIM languages list in a dynamic array, the list was prepared by a previous successful call to PrepareSimLanguages().

Note:

This API can only be called by processes with the SecureID of the System State Manager.

RSsmMiscAdaptation::PrepareSimLanguages

Parameters

TInt aSimLanguageCount

The count of the languages as prepared in a previous call to PrepareSimLanguages(). This count is used to allocate and expand the size of the flat buffer.