Symbian^3 Application Developer Library >

RhspsClientSession Class Reference

class RhspsClientSession : public RSessionBase

Server session.

hspsclientsession.lib
Since
S60 5.0

Inherits from

Protected Member Functions
IMPORT_C TInt AccessResourceFile ( TDes8 &, const ThspsConfiguration &, const TDesC &, TInt &)
IMPORT_C TInt AddPlugin ( TDes8 &, const ThpsParamAddPlugin &, TInt &)
IMPORT_C void CancelRequest ( TInt , TDes8 &, TInt )
IMPORT_C void Close ()
IMPORT_C TInt Connect ()
IMPORT_C TInt CopyResourceFiles ( TDes8 &, TDesC &, TDesC &)
IMPORT_C TInt GetListHeaders ( TDes8 &, const TDesC8 &, const TBool , TDes8 &)
IMPORT_C void GetNextHeader ( TDes8 &, TDes8 &, TRequestStatus &)
IMPORT_C TInt GetNextHeader ( TDes8 &, TDes8 &)
IMPORT_C TInt GetODT ( TDes8 &, const ThspsConfiguration &, const TDesC8 &, TDes &)
IMPORT_C void GetODTUpdate ( TDes8 &, TDes8 &, TDes8 &, TRequestStatus &)
IMPORT_C TInt GetPluginOdt ( TDes8 &, const ThspsParamGetPluginOdt &, TDes &)
IMPORT_C void InstallNextPhase ( TDes8 &, TDes8 &, TRequestStatus &)
IMPORT_C TInt InstallTheme ( TDes8 &, const TDesC &, TDes8 &)
IMPORT_C TInt MovePlugins ( TDes8 &, const ThpsParamMovePlugins &)
IMPORT_C TInt ReinstallConf ( TDes8 &, const ThspsParamReinstallConf &)
IMPORT_C TInt RemovePlugin ( TDes8 &, const ThpsParamRemovePlugin &)
IMPORT_C TInt RemoveTheme ( TDes8 &, const TDesC8 &)
IMPORT_C TInt ReplacePlugin ( TDes8 &, const ThspsParamReplacePlugin &)
IMPORT_C TInt RestoreActiveAppConf ( TDes8 &, const ThspsParamRestoreActiveAppConf &)
IMPORT_C TInt RestoreConfigurations ( TDes8 &, const ThspsParamRestoreConfigurations &)
IMPORT_C TInt RestoreDefault ( TDes8 &, const TDesC8 &, TDes8 &)
IMPORT_C TInt SetActivePlugin ( TDes8 &, const ThpsParamSetActivePlugin &)
IMPORT_C TInt SetActiveTheme ( TDes8 &, const TDesC8 &, TDes8 &)
IMPORT_C TInt SetConfState ( TDes8 &, const ThspsParamSetConfState &)
IMPORT_C TInt SetPluginSettings ( TDes8 &, TDes8 &, ThspsParamSetPluginSettings , TDes8 &)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
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()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Inherited Attributes
RHandleBase::iHandle

Member Functions Documentation

AccessResourceFile(TDes8 &, const ThspsConfiguration &, const TDesC &, TInt &)

IMPORT_C TInt AccessResourceFile ( TDes8 & aResultData,
const ThspsConfiguration & aConfiguration,
const TDesC & aFileName,
TInt & aFileHandle
) [protected]

AccessResourceFile. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData ResultData.
const ThspsConfiguration & aConfiguration Configuration.
const TDesC & aFileName File name.
TInt & aFileHandle File handle.

AddPlugin(TDes8 &, const ThpsParamAddPlugin &, TInt &)

IMPORT_C TInt AddPlugin ( TDes8 & aResultData,
const ThpsParamAddPlugin & aParams,
TInt & aNewPluginId
) [protected]

AddPlugin. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const ThpsParamAddPlugin & aParams Params.
TInt & aNewPluginId New plugin id.

CancelRequest(TInt, TDes8 &, TInt)

IMPORT_C void CancelRequest ( TInt aCancelRequestMessage,
TDes8 & aResultData,
TInt aAppUid = 0
) [protected]

CancelRequest. Synchronous service call.

Since
S60 5.0

Parameters

TInt aCancelRequestMessage Cancel request message.
TDes8 & aResultData Result data.
TInt aAppUid = 0 AppUid.

Close()

IMPORT_C void Close ( ) [protected]

Close.

Since
S60 5.0

Connect()

IMPORT_C TInt Connect ( ) [protected]

Connect.

Since
S60 5.0

CopyResourceFiles(TDes8 &, TDesC &, TDesC &)

IMPORT_C TInt CopyResourceFiles ( TDes8 & aResultData,
TDesC & aODTPath,
TDesC & aDestinationPath
) [protected]

Reads Odt from given path (aODTPath) and copies its resource files to destination folder (note that given destination folder is only prefix for actual destination folder).

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
TDesC & aODTPath odt path to be read.
TDesC & aDestinationPath target directory.

GetListHeaders(TDes8 &, const TDesC8 &, const TBool, TDes8 &)

IMPORT_C TInt GetListHeaders ( TDes8 & aResultData,
const TDesC8 & aSearchMaskData,
const TBool aCopyLogos,
TDes8 & aHeaderData
) [protected]

GetListHeaders. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const TDesC8 & aSearchMaskData Search mask data.
const TBool aCopyLogos Set if logo resources should be copied to client
TDes8 & aHeaderData Header data.

GetNextHeader(TDes8 &, TDes8 &, TRequestStatus &)

IMPORT_C void GetNextHeader ( TDes8 & aResultData,
TDes8 & aHeaderData,
TRequestStatus & aStatus
) [protected]

GetNextHeader. Asynchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
TDes8 & aHeaderData Header data.
TRequestStatus & aStatus Request status.

GetNextHeader(TDes8 &, TDes8 &)

IMPORT_C TInt GetNextHeader ( TDes8 & aResultData,
TDes8 & aHeaderData
) [protected]

GetNextHeader. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
TDes8 & aHeaderData Header data.

GetODT(TDes8 &, const ThspsConfiguration &, const TDesC8 &, TDes &)

IMPORT_C TInt GetODT ( TDes8 & aResultData,
const ThspsConfiguration & aConfiguration,
const TDesC8 & aRequestData,
TDes & aODTPath
) [protected]

GetODT. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData ResultData.
const ThspsConfiguration & aConfiguration Configuration.
const TDesC8 & aRequestData Request data.
TDes & aODTPath Odt path.

GetODTUpdate(TDes8 &, TDes8 &, TDes8 &, TRequestStatus &)

IMPORT_C void GetODTUpdate ( TDes8 & aResultData,
TDes8 & aRequestNotifyData,
TDes8 & aHeaderData,
TRequestStatus & aStatus
) [protected]

GetODTUpdate. Asynchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
TDes8 & aRequestNotifyData Request notify data.
TDes8 & aHeaderData Header data.
TRequestStatus & aStatus Request status.

GetPluginOdt(TDes8 &, const ThspsParamGetPluginOdt &, TDes &)

IMPORT_C TInt GetPluginOdt ( TDes8 & aResultData,
const ThspsParamGetPluginOdt & aParams,
TDes & aOdtPath
) [protected]

GetPluginOdt. Synchronous service call to get plugin's odt path.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const ThspsParamGetPluginOdt & aParams Params.
TDes & aOdtPath Odt path.

InstallNextPhase(TDes8 &, TDes8 &, TRequestStatus &)

IMPORT_C void InstallNextPhase ( TDes8 & aResultData,
TDes8 & aHeaderData,
TRequestStatus & aStatus
) [protected]

InstallNextPhase. Asynchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
TDes8 & aHeaderData Header data.
TRequestStatus & aStatus Request status.

InstallTheme(TDes8 &, const TDesC &, TDes8 &)

IMPORT_C TInt InstallTheme ( TDes8 & aResultData,
const TDesC & aManifestFileName,
TDes8 & aHeaderData
) [protected]

InstallTheme. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const TDesC & aManifestFileName Manifest file name.
TDes8 & aHeaderData Header data.

MovePlugins(TDes8 &, const ThpsParamMovePlugins &)

IMPORT_C TInt MovePlugins ( TDes8 & aResultData,
const ThpsParamMovePlugins & aParams
) [protected]

MovePlugins. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const ThpsParamMovePlugins & aParams Params.

ReinstallConf(TDes8 &, const ThspsParamReinstallConf &)

IMPORT_C TInt ReinstallConf ( TDes8 & aResultData,
const ThspsParamReinstallConf & aParams
) [protected]

ReinstallConf. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const ThspsParamReinstallConf & aParams Params.

RemovePlugin(TDes8 &, const ThpsParamRemovePlugin &)

IMPORT_C TInt RemovePlugin ( TDes8 & aResultData,
const ThpsParamRemovePlugin & aParams
) [protected]

RemovePlugin. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const ThpsParamRemovePlugin & aParams Params.

RemoveTheme(TDes8 &, const TDesC8 &)

IMPORT_C TInt RemoveTheme ( TDes8 & aResultData,
const TDesC8 & aSetMaskData
) [protected]

RemoveTheme. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const TDesC8 & aSetMaskData Mask data.

ReplacePlugin(TDes8 &, const ThspsParamReplacePlugin &)

IMPORT_C TInt ReplacePlugin ( TDes8 & aResultData,
const ThspsParamReplacePlugin & aParams
) [protected]

ReplacePlugin. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const ThspsParamReplacePlugin & aParams Params.

RestoreActiveAppConf(TDes8 &, const ThspsParamRestoreActiveAppConf &)

IMPORT_C TInt RestoreActiveAppConf ( TDes8 & aResultData,
const ThspsParamRestoreActiveAppConf & aParams
) [protected]
RestoreActiveAppConf Synchronous service call.
Since
S60 5.0

Parameters

TDes8 & aResultData Operation result
const ThspsParamRestoreActiveAppConf & aParams Operation parameters

RestoreConfigurations(TDes8 &, const ThspsParamRestoreConfigurations &)

IMPORT_C TInt RestoreConfigurations ( TDes8 & aResultData,
const ThspsParamRestoreConfigurations & aParams
) [protected]
Restores plugin configurations by either removing all plugins from the active view or by removing all extra views. In latter case, the first locked view is emptied. If there are no locked views then the first view will remain while others are removed.
Since
S60 5.2

Parameters

TDes8 & aResultData Result data.
const ThspsParamRestoreConfigurations & aParams Params.

RestoreDefault(TDes8 &, const TDesC8 &, TDes8 &)

IMPORT_C TInt RestoreDefault ( TDes8 & aResultData,
const TDesC8 & aSetMaskData,
TDes8 & aHeaderData
) [protected]

RestoreDefault. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const TDesC8 & aSetMaskData Mask data.
TDes8 & aHeaderData Header data.

SetActivePlugin(TDes8 &, const ThpsParamSetActivePlugin &)

IMPORT_C TInt SetActivePlugin ( TDes8 & aResultData,
const ThpsParamSetActivePlugin & aParams
) [protected]

SetActivePlugin. Set plugin configuration active.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const ThpsParamSetActivePlugin & aParams Params.

SetActiveTheme(TDes8 &, const TDesC8 &, TDes8 &)

IMPORT_C TInt SetActiveTheme ( TDes8 & aResultData,
const TDesC8 & aSetMaskData,
TDes8 & aHeaderData
) [protected]

SetActiveTheme. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const TDesC8 & aSetMaskData Mask data.
TDes8 & aHeaderData Header data.

SetConfState(TDes8 &, const ThspsParamSetConfState &)

IMPORT_C TInt SetConfState ( TDes8 & aResultData,
const ThspsParamSetConfState & aParams
) [protected]

SetConfState. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
const ThspsParamSetConfState & aParams Params.

SetPluginSettings(TDes8 &, TDes8 &, ThspsParamSetPluginSettings, TDes8 &)

IMPORT_C TInt SetPluginSettings ( TDes8 & aResultData,
TDes8 & aSearchMaskData,
ThspsParamSetPluginSettings aParams,
TDes8 & aDomData
) [protected]

SetPluginSettings. Synchronous service call.

Since
S60 5.0

Parameters

TDes8 & aResultData Result data.
TDes8 & aSearchMaskData Search mask data.
ThspsParamSetPluginSettings aParams
TDes8 & aDomData Dom data.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.