Collapse all Symbian^3 Application Developer Library

RSCPClient Class Reference

class RSCPClient : public RSessionBase

Implements the public interface towards the SCP Server Contains methods for controlling the server operation

Inherits from

RSCPClient
- RSessionBase
  - RHandleBase

Public Member Functions
	RSCPClient ()
IMPORT_C TInt	ChangeCode ( TDes &)
IMPORT_C TInt	ChangeCodeRequest ()
IMPORT_C TInt	CheckConfiguration ( TInt )
IMPORT_C TInt	Connect ()
IMPORT_C TInt	GetCode ( TSCPSecCode &)
IMPORT_C TInt	GetLockState ( TBool &)
IMPORT_C TInt	GetParamValue ( TInt , TDes &)
IMPORT_C TInt	PerformCleanupL ( RArray < TUid > &)
IMPORT_C TBool	QueryAdminCmd ( TSCPAdminCommand )
IMPORT_C TInt	SecCodeQuery ( RMobilePhone::TMobilePassword &, TSCPButtonConfig , TBool , TInt )
IMPORT_C TInt	SetAutoLockPeriod ( TInt )
IMPORT_C TInt	SetParamValue ( TInt , TDes &)
IMPORT_C TInt	SetParamValue ( TInt , TDes &, TUint32 )
IMPORT_C TInt	SetPhoneLock ( TBool )
IMPORT_C TInt	StoreCode ( TSCPSecCode &)
IMPORT_C TVersion	Version ()

Private Member Functions
void	FetchLimits ( TInt &, TInt &)
TInt	GetNewCodeAndChange ( TDes &, TInt , TSCPSecCode , HBufC *)
void	ProcessServerCommandsL ( TDes8 &, CSCPParamObject **, TBool )
TInt	SetSecurityCodeL ( RMobilePhone::TMobilePassword &, TSCPButtonConfig , TBool , TInt , TInt &, TInt &)
void	ShowUIL ( CSCPParamObject &)

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()

Public Member Enumerations
enum	TSCPButtonConfig { SCP_OK , SCP_OK_CANCEL , SCP_OK_ETEL , SCP_OK_CANCEL_ETEL }

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Private Attributes
TBool	isFlagEnabled

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RSCPClient()

IMPORT_C

RSCPClient

(

)

C++ default constructor.

Member Functions Documentation

ChangeCode(TDes &)

IMPORT_C TInt

ChangeCode

(

TDes &

aNewCode

)

Used to change the system security code, uses the stored code as the current one.

Parameters

TDes & aNewCode

A descriptor containing the new code

ChangeCodeRequest()

IMPORT_C TInt

ChangeCodeRequest

(

)

Prompt the user to change the security code.

CheckConfiguration(TInt)

IMPORT_C TInt

CheckConfiguration

(

TInt

aMode

)

Checks the server configuration and reports the status.

Parameters

TInt aMode

The check mode, initial or complete. The initial mode only checks if the configuration has already been validated.

Connect()

IMPORT_C TInt

Connect

(

)

The standard connection method, starts the server process, if necessary

FetchLimits(TInt &, TInt &)

void	FetchLimits	(	TInt &	aMin,
			TInt &	aMax
		)	[private]

Fetch the limit-values for code length

Parameters

TInt & aMin
TInt & aMax

GetCode(TSCPSecCode &)

IMPORT_C TInt

GetCode

(

TSCPSecCode &

aCode

)

A method for querying the stored ISA code

Parameters

TSCPSecCode & aCode

A buffer for storing the code

GetLockState(TBool &)

IMPORT_C TInt

GetLockState

(

TBool &

aState

)

Query the current state of the system lock.

Parameters

TBool & aState

Will contain the state after a successful call.

GetNewCodeAndChange(TDes &, TInt, TSCPSecCode *, HBufC **)

TInt	GetNewCodeAndChange	(	TDes &	aOldCode,
			TInt	aMode,
			TSCPSecCode *	aNewDOSCode = NULL,
			HBufC **	aNewCodePptr = NULL
		)	[private]

Request the new code from the user and try to change the code

Parameters

TDes & aOldCode
TInt aMode
TSCPSecCode * aNewDOSCode = NULL
HBufC ** aNewCodePptr = NULL

GetParamValue(TInt, TDes &)

IMPORT_C TInt	GetParamValue	(	TInt	aParamID,
			TDes &	aValue
		)

Get the value of an identified parameter stored on the server.

Parameters

TInt aParamID	The ID of the requested parameter.
TDes & aValue	Will contain the requested value after a successful call.

PerformCleanupL(RArray< TUid > &)

IMPORT_C TInt

PerformCleanupL

(

RArray < TUid > &

aAppIDs

)

This function can be used to cleanup the parameter values stored by any application, initialize the parameters to default values. The call notifies the stakeholders (Other applications that may be using the same parameters) about the change (value being revoked to default)

Parameters

RArray < TUid > & aAppIDs

ProcessServerCommandsL(TDes8 &, CSCPParamObject **, TBool)

void	ProcessServerCommandsL	(	TDes8 &	aInParams,
			CSCPParamObject **	aOutParams = NULL,
			TBool	isNotifierEvent = EFalse
		)	[private]

Process the server's response-commands

Parameters

TDes8 & aInParams
CSCPParamObject ** aOutParams = NULL
TBool isNotifierEvent = EFalse

QueryAdminCmd(TSCPAdminCommand)

IMPORT_C TBool

QueryAdminCmd

(

TSCPAdminCommand

aCommand

)

A method for retrieving the operational status of the server in relation to the given command.

Parameters

TSCPAdminCommand aCommand

The command, whose status will be queried

SecCodeQuery(RMobilePhone::TMobilePassword &, TSCPButtonConfig, TBool, TInt)

IMPORT_C TInt	SecCodeQuery	(	RMobilePhone::TMobilePassword &	aPassword,
			TSCPButtonConfig	aButtonsShown,
			TBool	aECSSupport,
			TInt	aFlags
		)

Request the security code from the user.

Parameters

RMobilePhone::TMobilePassword & aPassword
TSCPButtonConfig aButtonsShown
TBool aECSSupport
TInt aFlags

SetAutoLockPeriod(TInt)

IMPORT_C TInt

SetAutoLockPeriod

(

TInt

aValue

)

Parameters

TInt aValue

SetParamValue(TInt, TDes &)

IMPORT_C TInt	SetParamValue	(	TInt	aParamID,
			TDes &	aValue
		)

Get the value of an identified parameter stored on the server. NOTE: FUNCTION IS DEPRECATED. Use SetParamValue( TInt aParamID, TDes& aValue, const TUint32 aCallerID ) instead.

Parameters

TInt aParamID	The ID of the requested parameter.
TDes & aValue

SetParamValue(TInt, TDes &, TUint32)

IMPORT_C TInt	SetParamValue	(	TInt	aParamID,
			TDes &	aValue,
			TUint32	aCallerID
		)

Get the value of an identified parameter stored on the server. NOTE: Currently TCServer is the only component that is capable of calling this function TCServer is assured to send the correct caller id always.

NOTE: FUNCTION IS DEPRECATED. Use SetParamValue( TInt aParamID, TDes& aValue, const TUint32 aCallerID ) instead.

Parameters

TInt aParamID	The ID of the requested parameter.
TDes & aValue	The value to be set.
TUint32 aCallerID	The SID of the calling application.

SetPhoneLock(TBool)

IMPORT_C TInt

SetPhoneLock

(

TBool

aLocked

)

Used to lock the phone, uses the stored code for verifying the request

Parameters

TBool aLocked

ETrue to lock the phone, EFalse to unlock.

SetSecurityCodeL(RMobilePhone::TMobilePassword &, TSCPButtonConfig, TBool, TInt, TInt &, TInt &)

TInt	SetSecurityCodeL	(	RMobilePhone::TMobilePassword &	aPassword,
			TSCPButtonConfig	aButtonsShown,
			TBool	aECSSupport,
			TInt	aFlags,
			TInt &	aResFileSCP,
			TInt &	aResFileSecUi
		)	[private]

Request the security code from the user (encapsulates functionalities of SecCodeQuery() ).

Parameters

RMobilePhone::TMobilePassword & aPassword
TSCPButtonConfig aButtonsShown
TBool aECSSupport
TInt aFlags
TInt & aResFileSCP
TInt & aResFileSecUi

ShowUIL(CSCPParamObject &)

void

ShowUIL

(

CSCPParamObject &

aContext

)

[private]

Show UI controls based on server commands

Parameters

CSCPParamObject & aContext

StoreCode(TSCPSecCode &)

IMPORT_C TInt

StoreCode

(

TSCPSecCode &

aCode

)

Used to store the new code, the user has set, in SCP

Parameters

TSCPSecCode & aCode

A descriptor containing the new code

Version()

IMPORT_C TVersion

Version

(

)

const

Version query

Member Enumerations Documentation

Enum TSCPButtonConfig

Enumerators

SCP_OK
SCP_OK_CANCEL
SCP_OK_ETEL
SCP_OK_CANCEL_ETEL

Member Data Documentation

TBool isFlagEnabled

TBool

isFlagEnabled

[private]