RMsvServerSession Class Reference

class RMsvServerSession : public RSessionBase

Low level client-side API to access the message server.

It should not be used directly by client applications. They should use higher-level helper classes such as CMsvSession, CMsEntry, and CMsvStore. These helper classes access the message server through RMsvServerSession.

Inherits from

Public Member Functions
RMsvServerSession()
~RMsvServerSession()
IMPORT_C voidAttachmentFilePathL(TMsvId, TDes &)
IMPORT_C voidBodyTextFilePathL(TMsvId, TDes &)
IMPORT_C TIntCancelOperation(TMsvOp, TDes8 &)
intCancelSearchSortOperation(TMsvOp)
IMPORT_C TIntCancelSessionEventRequest()
IMPORT_C voidChangeAttributesL(const CMsvEntrySelection &, TUint, TUint)
voidChangeDriveL(TInt, TMsvOp, TRequestStatus &)
IMPORT_C voidChangeEntryL(const TMsvEntry &, TMsvOp, TSecureId)
IMPORT_C voidChangeEntryL(const TMsvEntry &, TMsvOp, TSecureId, TRequestStatus &)
IMPORT_C voidCloseMessageServer()
IMPORT_C TIntConnect(RFs &)
IMPORT_C voidCopyEntriesL(const CMsvEntrySelection &, TMsvId, TMsvOp)
IMPORT_C voidCopyEntriesL(const CMsvEntrySelection &, TMsvId, TMsvOp, TRequestStatus &)
voidCopyStoreL(const TDriveUnit &, TMsvOp, TRequestStatus &)
IMPORT_C TBoolCreateAttachmentForWriteL(TMsvId, TDes &, RFile &)
IMPORT_C voidCreateEntryL(const TMsvEntry &, TMsvOp, TSecureId)
IMPORT_C voidCreateEntryL(const TMsvEntry &, TMsvOp, TSecureId, TRequestStatus &)
IMPORT_C voidCreatePlainTextFileL(RFile &, TMsvId)
IMPORT_C TBoolCreateShareProtectedAttachmentForWriteL(TMsvId, TDes &, RFile &)
IMPORT_C TIntDeInstallMtmGroup(const TDesC &)
TInt DecStoreReaderCount(TMsvId)
IMPORT_C TIntDeleteAttachment(TMsvId, const TDesC &)
IMPORT_C voidDeleteEntriesL(const CMsvEntrySelection &, TMsvOp)
IMPORT_C voidDeleteEntriesL(const CMsvEntrySelection &, TMsvOp, TRequestStatus &)
IMPORT_C voidDeleteFileStoreL(TMsvId)
IMPORT_C voidDeletePlainTextFileL(TMsvId)
voidDeleteStoreL(const TDriveUnit &, TMsvOp, TRequestStatus &)
TBool DriveContainsStoreL(TDriveUnit)
IMPORT_C TBoolFileExistsL(const TDesC &)
IMPORT_C TBoolFileStoreExistsL(TMsvId)
IMPORT_C TIntFillRegisteredMtmDllArray(TUid, CRegisteredMtmDllArray &, TTimeIntervalMicroSeconds32)
TBool GetAndClearIndexCorruptFlagL()
IMPORT_C voidGetChildIdsL(TMsvId, const CMsvEntryFilter &, CMsvEntrySelection &)
IMPORT_C TIntGetChildren(TMsvId, CArrayPtrFlat< CMsvClientEntry > &, const TMsvSelectionOrdering &)
IMPORT_C TIntGetEntry(TMsvId, TMsvId &, TMsvEntry &)
IMPORT_C TIntGetMessageDirectory(TDes &)
TInt GetMessageDrive()
IMPORT_C CMtmGroupData *GetMtmGroupDataL(TUid)
voidGetMtmRequiredCapabilitiesL(TUid, TCapabilitySet &)
voidGetNextEntryL(TMsvEntry &, TInt &)
voidGetNextIdL(TMsvId &, TInt &)
TInt GetNonOperationMtmData(TMsvId, const TNonOperationMtmDataType &, TDes8 &)
voidGetQueryFromServerL(TMsvOp, TInt, CMsvSearchSortQuery *)
voidGetResultAsIdL(RArray< TMsvId > &)
voidGetResultAsIdL(RArray< TMsvId > &, TInt &)
voidGetResultCountL(TInt &)
voidGetResultsForQueryId(TInt &, TMsvOp, TInt, TRequestStatus &)
voidGetSearchSortRequestQueryIdL(TInt &)
IMPORT_C TIntInstallMtmGroup(const TDesC &)
IMPORT_C TIntLockEntry(TMsvId)
IMPORT_C TIntLockStore(TMsvId)
IMPORT_C TBoolMessageStoreDrivePresentL()
IMPORT_C voidMoveEntriesL(const CMsvEntrySelection &, TMsvId, TMsvOp)
IMPORT_C voidMoveEntriesL(const CMsvEntrySelection &, TMsvId, TMsvOp, TRequestStatus &)
TUint32 NotifySequenceL()
IMPORT_C voidOpenAttachmentForWriteL(TMsvId, const TDesC &, RFile &)
IMPORT_C voidOpenAttachmentL(TMsvId, const TDesC &, RFile &)
IMPORT_C voidOpenBodyTextFileForReadL(RFile &, TMsvId, const TDesC &)
IMPORT_C TIntOpenFileStoreForRead(TMsvId, RFile &)
IMPORT_C voidOpenTempStoreFileL(TMsvId, RFile &)
IMPORT_C TIntOperationCompletion(TMsvOp, TDes8 &)
IMPORT_C TIntOperationMtmL(TMsvId, TMsvId, TUid &, TMsvId &)
TInt OperationMtmL(TMsvId, TUid &, TMsvId &)
IMPORT_C TIntOperationProgress(TMsvOp, TDes8 &)
IMPORT_C TIntOperationSystemProgress(TMsvOp, TMsvSystemProgress &)
TInt OutstandingOperationsL()
IMPORT_C voidQueueSessionEventRequest(TDes8 &, TDes8 &, TRequestStatus &)
IMPORT_C TIntReadStore(TMsvId)
IMPORT_C TIntReleaseEntry(TMsvId)
IMPORT_C TIntReleaseMtmGroup(TUid)
IMPORT_C TIntReleaseStore(TMsvId)
IMPORT_C voidRemoveEntry(TMsvId)
IMPORT_C TIntRenameAttachment(TMsvId, const TDesC &, const TDesC &)
IMPORT_C voidReplaceAttachmentForWriteL(TMsvId, TDes &, RFile &)
IMPORT_C voidReplaceFileStoreL(TMsvId)
IMPORT_C voidReplacePlainTextFileL(TMsvId)
voidSearchSortOperationProgressL(TMsvOp, TInt)
voidSearchSortRequestOnEntryL(const CMsvSearchSortQuery *, TMsvOp, TBool, TInt, TRequestStatus &)
voidSearchSortRequestOnHeaderBodyL(const CMsvSearchSortQuery *, TMsvOp, TBool, TRequestStatus &)
voidSendNewResultsToServerForSortL(TMsvOp, RArray< TMsvId > &, TRequestStatus &)
voidSendResultantListL(TMsvOp, RArray< TMsvIdWithSortField >, TRequestStatus &)
IMPORT_C TBoolServiceActive(TMsvId)
IMPORT_C TIntServiceProgress(TMsvId, TDes8 &)
IMPORT_C voidSetFailure(TInt, TInt, TInt, TInt)
IMPORT_C TIntSetReceiveEntryEvents(TBool)
TInt SetSessionAsObserver()
IMPORT_C TIntStopService(TMsvId)
IMPORT_C voidTransferCommandL(const CMsvEntrySelection &, TInt, const TDesC8 &, TMsvOp, TRequestStatus &)
IMPORT_C TIntTransferCommandL(const CMsvEntrySelection &, TInt, const TDesC8 &, TMsvOp)
voidUnmarkSearchSortRequestQueryIdL(TInt)
IMPORT_C TIntUseMtmGroup(TUid)
IMPORT_C TVersionVersion()
Private Member Functions
voidDoGetChildrenL(TMsvId, CArrayPtrFlat< CMsvClientEntry > &, const TMsvSelectionOrdering &)
voidDoGetEntryL(TMsvId, TMsvId &, TMsvEntry &)
voidDoGetRemainingChildrenL(TPckgBuf< TMsvChildrenDetails > &, CArrayPtrFlat< CMsvClientEntry > &)
voidPackEntryIntoBufferL(const TMsvEntry &)
voidPackOperationDataL(const CMsvEntrySelection &, TInt, TInt)
voidSendCommandDataL(TMsvOp, const CMsvEntrySelection &, TInt, const TDesC8 &)
voidSendEntryDataL(TMsvOp, const TMsvEntry &)
voidSendOperationDataL(TMsvOp, const CMsvEntrySelection &, TInt, TInt)
voidTestSlotAvailableL()
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()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
HBufC8 *iBuffer
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RMsvServerSession()

IMPORT_CRMsvServerSession()

~RMsvServerSession()

IMPORT_C~RMsvServerSession()[virtual]

Member Functions Documentation

AttachmentFilePathL(TMsvId, TDes &)

IMPORT_C voidAttachmentFilePathL(TMsvIdaEntryId,
TDes &aFilePath
)

Parameters

TMsvId aEntryId
TDes & aFilePath

BodyTextFilePathL(TMsvId, TDes &)

IMPORT_C voidBodyTextFilePathL(TMsvIdaBodyTextId,
TDes &aFilePath
)

Parameters

TMsvId aBodyTextId
TDes & aFilePath

CancelOperation(TMsvOp, TDes8 &)

IMPORT_C TIntCancelOperation(TMsvOpaId,
TDes8 &aProgress
)

Parameters

TMsvOp aId
TDes8 & aProgress

CancelSearchSortOperation(TMsvOp)

intCancelSearchSortOperation(TMsvOpaOperationId)

Parameters

TMsvOp aOperationId

CancelSessionEventRequest()

IMPORT_C TIntCancelSessionEventRequest()

ChangeAttributesL(const CMsvEntrySelection &, TUint, TUint)

IMPORT_C voidChangeAttributesL(const CMsvEntrySelection &aSelection,
TUintaSetAttributes,
TUintaClearAttributes
)

Parameters

const CMsvEntrySelection & aSelection
TUint aSetAttributes
TUint aClearAttributes

ChangeDriveL(TInt, TMsvOp, TRequestStatus &)

voidChangeDriveL(TIntaDrive,
TMsvOpaOperationId,
TRequestStatus &aRequestStatus
)

Parameters

TInt aDrive
TMsvOp aOperationId
TRequestStatus & aRequestStatus

ChangeEntryL(const TMsvEntry &, TMsvOp, TSecureId)

IMPORT_C voidChangeEntryL(const TMsvEntry &aEntry,
TMsvOpaOperationId,
TSecureIdaOwnerId
)

Parameters

const TMsvEntry & aEntry
TMsvOp aOperationId
TSecureId aOwnerId

ChangeEntryL(const TMsvEntry &, TMsvOp, TSecureId, TRequestStatus &)

IMPORT_C voidChangeEntryL(const TMsvEntry &aEntry,
TMsvOpaOperationId,
TSecureIdaOwnerId,
TRequestStatus &aRequestStatus
)

Parameters

const TMsvEntry & aEntry
TMsvOp aOperationId
TSecureId aOwnerId
TRequestStatus & aRequestStatus

CloseMessageServer()

IMPORT_C voidCloseMessageServer()

Connect(RFs &)

IMPORT_C TIntConnect(RFs &aFs)

Parameters

RFs & aFs

CopyEntriesL(const CMsvEntrySelection &, TMsvId, TMsvOp)

IMPORT_C voidCopyEntriesL(const CMsvEntrySelection &aSelection,
TMsvIdaTarget,
TMsvOpaOperationId
)

Parameters

const CMsvEntrySelection & aSelection
TMsvId aTarget
TMsvOp aOperationId

CopyEntriesL(const CMsvEntrySelection &, TMsvId, TMsvOp, TRequestStatus &)

IMPORT_C voidCopyEntriesL(const CMsvEntrySelection &aSelection,
TMsvIdaTarget,
TMsvOpaOperationId,
TRequestStatus &aRequestStatus
)

Parameters

const CMsvEntrySelection & aSelection
TMsvId aTarget
TMsvOp aOperationId
TRequestStatus & aRequestStatus

CopyStoreL(const TDriveUnit &, TMsvOp, TRequestStatus &)

voidCopyStoreL(const TDriveUnit &aDrive,
TMsvOpaOperationId,
TRequestStatus &aStatus
)

Parameters

const TDriveUnit & aDrive
TMsvOp aOperationId
TRequestStatus & aStatus

CreateAttachmentForWriteL(TMsvId, TDes &, RFile &)

IMPORT_C TBoolCreateAttachmentForWriteL(TMsvIdaEntryId,
TDes &aFilename,
RFile &aFile
)

Parameters

TMsvId aEntryId
TDes & aFilename
RFile & aFile

CreateEntryL(const TMsvEntry &, TMsvOp, TSecureId)

IMPORT_C voidCreateEntryL(const TMsvEntry &aEntry,
TMsvOpaOperationId,
TSecureIdaOwnerId
)

Parameters

const TMsvEntry & aEntry
TMsvOp aOperationId
TSecureId aOwnerId

CreateEntryL(const TMsvEntry &, TMsvOp, TSecureId, TRequestStatus &)

IMPORT_C voidCreateEntryL(const TMsvEntry &aEntry,
TMsvOpaOperationId,
TSecureIdaOwnerId,
TRequestStatus &aRequestStatus
)

Parameters

const TMsvEntry & aEntry
TMsvOp aOperationId
TSecureId aOwnerId
TRequestStatus & aRequestStatus

CreatePlainTextFileL(RFile &, TMsvId)

IMPORT_C voidCreatePlainTextFileL(RFile &aFile,
TMsvIdaBodyTextId
)

Parameters

RFile & aFile
TMsvId aBodyTextId

CreateShareProtectedAttachmentForWriteL(TMsvId, TDes &, RFile &)

IMPORT_C TBoolCreateShareProtectedAttachmentForWriteL(TMsvIdaEntryId,
TDes &aFilename,
RFile &aFile
)

Parameters

TMsvId aEntryId
TDes & aFilename
RFile & aFile

DeInstallMtmGroup(const TDesC &)

IMPORT_C TIntDeInstallMtmGroup(const TDesC &aFullName)

Parameters

const TDesC & aFullName

DecStoreReaderCount(TMsvId)

TInt DecStoreReaderCount(TMsvIdaId)

Parameters

TMsvId aId

DeleteAttachment(TMsvId, const TDesC &)

IMPORT_C TIntDeleteAttachment(TMsvIdaEntryId,
const TDesC &aFilePath
)

Parameters

TMsvId aEntryId
const TDesC & aFilePath

DeleteEntriesL(const CMsvEntrySelection &, TMsvOp)

IMPORT_C voidDeleteEntriesL(const CMsvEntrySelection &aSelection,
TMsvOpaOperationId
)

Parameters

const CMsvEntrySelection & aSelection
TMsvOp aOperationId

DeleteEntriesL(const CMsvEntrySelection &, TMsvOp, TRequestStatus &)

IMPORT_C voidDeleteEntriesL(const CMsvEntrySelection &aSelection,
TMsvOpaOperationId,
TRequestStatus &aRequestStatus
)

Parameters

const CMsvEntrySelection & aSelection
TMsvOp aOperationId
TRequestStatus & aRequestStatus

DeleteFileStoreL(TMsvId)

IMPORT_C voidDeleteFileStoreL(TMsvIdaEntryId)

Parameters

TMsvId aEntryId

DeletePlainTextFileL(TMsvId)

IMPORT_C voidDeletePlainTextFileL(TMsvIdaBodyTextId)

Parameters

TMsvId aBodyTextId

DeleteStoreL(const TDriveUnit &, TMsvOp, TRequestStatus &)

voidDeleteStoreL(const TDriveUnit &aDrive,
TMsvOpaOperationId,
TRequestStatus &aStatus
)

Parameters

const TDriveUnit & aDrive
TMsvOp aOperationId
TRequestStatus & aStatus

DoGetChildrenL(TMsvId, CArrayPtrFlat< CMsvClientEntry > &, const TMsvSelectionOrdering &)

voidDoGetChildrenL(TMsvIdaId,
CArrayPtrFlat< CMsvClientEntry > &aEntries,
const TMsvSelectionOrdering &aOrdering
)[private]

Parameters

TMsvId aId
CArrayPtrFlat< CMsvClientEntry > & aEntries
const TMsvSelectionOrdering & aOrdering

DoGetEntryL(TMsvId, TMsvId &, TMsvEntry &)

voidDoGetEntryL(TMsvIdaId,
TMsvId &aService,
TMsvEntry &aEntry
)[private]

Parameters

TMsvId aId
TMsvId & aService
TMsvEntry & aEntry

DoGetRemainingChildrenL(TPckgBuf< TMsvChildrenDetails > &, CArrayPtrFlat< CMsvClientEntry > &)

voidDoGetRemainingChildrenL(TPckgBuf< TMsvChildrenDetails > &aDetails,
CArrayPtrFlat< CMsvClientEntry > &aEntries
)[private]

Parameters

TPckgBuf< TMsvChildrenDetails > & aDetails
CArrayPtrFlat< CMsvClientEntry > & aEntries

DriveContainsStoreL(TDriveUnit)

TBool DriveContainsStoreL(TDriveUnitaDrive)

Parameters

TDriveUnit aDrive

FileExistsL(const TDesC &)

IMPORT_C TBoolFileExistsL(const TDesC &aFilePath)

Parameters

const TDesC & aFilePath

FileStoreExistsL(TMsvId)

IMPORT_C TBoolFileStoreExistsL(TMsvIdaEntryId)const

Parameters

TMsvId aEntryId

FillRegisteredMtmDllArray(TUid, CRegisteredMtmDllArray &, TTimeIntervalMicroSeconds32)

IMPORT_C TIntFillRegisteredMtmDllArray(TUidaMtmDllTypeUid,
CRegisteredMtmDllArray &aRegisteredMtmDllArray,
TTimeIntervalMicroSeconds32aTimeoutMicroSeconds32
)

Parameters

TUid aMtmDllTypeUid
CRegisteredMtmDllArray & aRegisteredMtmDllArray
TTimeIntervalMicroSeconds32 aTimeoutMicroSeconds32

GetAndClearIndexCorruptFlagL()

TBool GetAndClearIndexCorruptFlagL()

GetChildIdsL(TMsvId, const CMsvEntryFilter &, CMsvEntrySelection &)

IMPORT_C voidGetChildIdsL(TMsvIdaId,
const CMsvEntryFilter &aFilter,
CMsvEntrySelection &aSelection
)

Parameters

TMsvId aId
const CMsvEntryFilter & aFilter
CMsvEntrySelection & aSelection

GetChildren(TMsvId, CArrayPtrFlat< CMsvClientEntry > &, const TMsvSelectionOrdering &)

IMPORT_C TIntGetChildren(TMsvIdaId,
CArrayPtrFlat< CMsvClientEntry > &aEntries,
const TMsvSelectionOrdering &aOrdering
)

Parameters

TMsvId aId
CArrayPtrFlat< CMsvClientEntry > & aEntries
const TMsvSelectionOrdering & aOrdering

GetEntry(TMsvId, TMsvId &, TMsvEntry &)

IMPORT_C TIntGetEntry(TMsvIdaId,
TMsvId &aService,
TMsvEntry &aEntry
)

Parameters

TMsvId aId
TMsvId & aService
TMsvEntry & aEntry

GetMessageDirectory(TDes &)

IMPORT_C TIntGetMessageDirectory(TDes &aDirectory)

Parameters

TDes & aDirectory

GetMessageDrive()

TInt GetMessageDrive()

GetMtmGroupDataL(TUid)

IMPORT_C CMtmGroupData *GetMtmGroupDataL(TUidaMtmTypeUid)

Parameters

TUid aMtmTypeUid

GetMtmRequiredCapabilitiesL(TUid, TCapabilitySet &)

voidGetMtmRequiredCapabilitiesL(TUidaMtmTypeUid,
TCapabilitySet &aCapSet
)const

Parameters

TUid aMtmTypeUid
TCapabilitySet & aCapSet

GetNextEntryL(TMsvEntry &, TInt &)

voidGetNextEntryL(TMsvEntry &aEntry,
TInt &aCount
)

Parameters

TMsvEntry & aEntry
TInt & aCount

GetNextIdL(TMsvId &, TInt &)

voidGetNextIdL(TMsvId &aId,
TInt &aCount
)

Parameters

TMsvId & aId
TInt & aCount

GetNonOperationMtmData(TMsvId, const TNonOperationMtmDataType &, TDes8 &)

TInt GetNonOperationMtmData(TMsvIdaServiceId,
const TNonOperationMtmDataType &aType,
TDes8 &aMtmData
)

Parameters

TMsvId aServiceId
const TNonOperationMtmDataType & aType
TDes8 & aMtmData

GetQueryFromServerL(TMsvOp, TInt, CMsvSearchSortQuery *)

voidGetQueryFromServerL(TMsvOpaOperationId,
TIntaQueryId,
CMsvSearchSortQuery *aQuery
)

Parameters

TMsvOp aOperationId
TInt aQueryId
CMsvSearchSortQuery * aQuery

GetResultAsIdL(RArray< TMsvId > &)

voidGetResultAsIdL(RArray< TMsvId > &aId)

Parameters

RArray< TMsvId > & aId

GetResultAsIdL(RArray< TMsvId > &, TInt &)

voidGetResultAsIdL(RArray< TMsvId > &aId,
TInt &aResultStatus
)

Parameters

RArray< TMsvId > & aId
TInt & aResultStatus

GetResultCountL(TInt &)

voidGetResultCountL(TInt &aCount)

Parameters

TInt & aCount

GetResultsForQueryId(TInt &, TMsvOp, TInt, TRequestStatus &)

voidGetResultsForQueryId(TInt &aQueryId,
TMsvOpaOperationId,
TIntaIterator,
TRequestStatus &aRequestStatus
)

Parameters

TInt & aQueryId
TMsvOp aOperationId
TInt aIterator
TRequestStatus & aRequestStatus

GetSearchSortRequestQueryIdL(TInt &)

voidGetSearchSortRequestQueryIdL(TInt &aQueryId)

Parameters

TInt & aQueryId

InstallMtmGroup(const TDesC &)

IMPORT_C TIntInstallMtmGroup(const TDesC &aFullName)

Parameters

const TDesC & aFullName

LockEntry(TMsvId)

IMPORT_C TIntLockEntry(TMsvIdaId)

Parameters

TMsvId aId

LockStore(TMsvId)

IMPORT_C TIntLockStore(TMsvIdaId)

Parameters

TMsvId aId

MessageStoreDrivePresentL()

IMPORT_C TBoolMessageStoreDrivePresentL()

MoveEntriesL(const CMsvEntrySelection &, TMsvId, TMsvOp)

IMPORT_C voidMoveEntriesL(const CMsvEntrySelection &aSelection,
TMsvIdaTarget,
TMsvOpaOperationId
)

Parameters

const CMsvEntrySelection & aSelection
TMsvId aTarget
TMsvOp aOperationId

MoveEntriesL(const CMsvEntrySelection &, TMsvId, TMsvOp, TRequestStatus &)

IMPORT_C voidMoveEntriesL(const CMsvEntrySelection &aSelection,
TMsvIdaTarget,
TMsvOpaOperationId,
TRequestStatus &aRequestStatus
)

Parameters

const CMsvEntrySelection & aSelection
TMsvId aTarget
TMsvOp aOperationId
TRequestStatus & aRequestStatus

NotifySequenceL()

TUint32 NotifySequenceL()

OpenAttachmentForWriteL(TMsvId, const TDesC &, RFile &)

IMPORT_C voidOpenAttachmentForWriteL(TMsvIdaEntryId,
const TDesC &aFilePath,
RFile &aFile
)

Parameters

TMsvId aEntryId
const TDesC & aFilePath
RFile & aFile

OpenAttachmentL(TMsvId, const TDesC &, RFile &)

IMPORT_C voidOpenAttachmentL(TMsvIdaEntryId,
const TDesC &aFilePath,
RFile &aFile
)

Parameters

TMsvId aEntryId
const TDesC & aFilePath
RFile & aFile

OpenBodyTextFileForReadL(RFile &, TMsvId, const TDesC &)

IMPORT_C voidOpenBodyTextFileForReadL(RFile &aFile,
TMsvIdaBodyTextId,
const TDesC &aFilePath
)

Parameters

RFile & aFile
TMsvId aBodyTextId
const TDesC & aFilePath

OpenFileStoreForRead(TMsvId, RFile &)

IMPORT_C TIntOpenFileStoreForRead(TMsvIdaEntryId,
RFile &aFile
)

Parameters

TMsvId aEntryId
RFile & aFile

OpenTempStoreFileL(TMsvId, RFile &)

IMPORT_C voidOpenTempStoreFileL(TMsvIdaEntryId,
RFile &aFile
)

Parameters

TMsvId aEntryId
RFile & aFile

OperationCompletion(TMsvOp, TDes8 &)

IMPORT_C TIntOperationCompletion(TMsvOpaId,
TDes8 &aProgress
)

Parameters

TMsvOp aId
TDes8 & aProgress

OperationMtmL(TMsvId, TMsvId, TUid &, TMsvId &)

IMPORT_C TIntOperationMtmL(TMsvIdaId1,
TMsvIdaId2,
TUid &aMtm,
TMsvId &aService
)

Parameters

TMsvId aId1
TMsvId aId2
TUid & aMtm
TMsvId & aService

OperationMtmL(TMsvId, TUid &, TMsvId &)

TInt OperationMtmL(TMsvIdaId1,
TUid &aMtm,
TMsvId &aService
)[inline]

Gets the MTM that would perform an operation on a specified entry.

System wide error code

capability

None

Parameters

TMsvId aId1ID of the entry
TUid & aMtmOn return, the UID of the MTM that would be used
TMsvId & aServiceOn return, the ID of the service that would be used

OperationProgress(TMsvOp, TDes8 &)

IMPORT_C TIntOperationProgress(TMsvOpaId,
TDes8 &aProgress
)

Parameters

TMsvOp aId
TDes8 & aProgress

OperationSystemProgress(TMsvOp, TMsvSystemProgress &)

IMPORT_C TIntOperationSystemProgress(TMsvOpaId,
TMsvSystemProgress &aProgress
)

Parameters

TMsvOp aId
TMsvSystemProgress & aProgress

OutstandingOperationsL()

TInt OutstandingOperationsL()

PackEntryIntoBufferL(const TMsvEntry &)

voidPackEntryIntoBufferL(const TMsvEntry &aEntry)[private]

Parameters

const TMsvEntry & aEntry

PackOperationDataL(const CMsvEntrySelection &, TInt, TInt)

voidPackOperationDataL(const CMsvEntrySelection &aSelection,
TIntaParameter1,
TIntaParameter2
)[private]

Parameters

const CMsvEntrySelection & aSelection
TInt aParameter1
TInt aParameter2

QueueSessionEventRequest(TDes8 &, TDes8 &, TRequestStatus &)

IMPORT_C voidQueueSessionEventRequest(TDes8 &aChange,
TDes8 &aSequence,
TRequestStatus &aRequestStatus
)

Parameters

TDes8 & aChange
TDes8 & aSequence
TRequestStatus & aRequestStatus

ReadStore(TMsvId)

IMPORT_C TIntReadStore(TMsvIdaId)

Parameters

TMsvId aId

ReleaseEntry(TMsvId)

IMPORT_C TIntReleaseEntry(TMsvIdaId)

Parameters

TMsvId aId

ReleaseMtmGroup(TUid)

IMPORT_C TIntReleaseMtmGroup(TUidaMtmTypeUid)

Parameters

TUid aMtmTypeUid

ReleaseStore(TMsvId)

IMPORT_C TIntReleaseStore(TMsvIdaId)

Parameters

TMsvId aId

RemoveEntry(TMsvId)

IMPORT_C voidRemoveEntry(TMsvIdaId)

Parameters

TMsvId aId

RenameAttachment(TMsvId, const TDesC &, const TDesC &)

IMPORT_C TIntRenameAttachment(TMsvIdaEntryId,
const TDesC &aOldFilePath,
const TDesC &aNewName
)

Parameters

TMsvId aEntryId
const TDesC & aOldFilePath
const TDesC & aNewName

ReplaceAttachmentForWriteL(TMsvId, TDes &, RFile &)

IMPORT_C voidReplaceAttachmentForWriteL(TMsvIdaEntryId,
TDes &aFilename,
RFile &aFile
)

Parameters

TMsvId aEntryId
TDes & aFilename
RFile & aFile

ReplaceFileStoreL(TMsvId)

IMPORT_C voidReplaceFileStoreL(TMsvIdaEntryId)

Parameters

TMsvId aEntryId

ReplacePlainTextFileL(TMsvId)

IMPORT_C voidReplacePlainTextFileL(TMsvIdaBodyTextId)

Parameters

TMsvId aBodyTextId

SearchSortOperationProgressL(TMsvOp, TInt)

voidSearchSortOperationProgressL(TMsvOpaOperationId,
TIntaOperationProgress
)

Parameters

TMsvOp aOperationId
TInt aOperationProgress

SearchSortRequestOnEntryL(const CMsvSearchSortQuery *, TMsvOp, TBool, TInt, TRequestStatus &)

voidSearchSortRequestOnEntryL(const CMsvSearchSortQuery *aQuery,
TMsvOpaOperationId,
TBoolaMarkQuery,
TIntaIterator,
TRequestStatus &aRequestStatus
)

Parameters

const CMsvSearchSortQuery * aQuery
TMsvOp aOperationId
TBool aMarkQuery
TInt aIterator
TRequestStatus & aRequestStatus

SearchSortRequestOnHeaderBodyL(const CMsvSearchSortQuery *, TMsvOp, TBool, TRequestStatus &)

voidSearchSortRequestOnHeaderBodyL(const CMsvSearchSortQuery *aQuery,
TMsvOpaOperationId,
TBoolaMarkQuery,
TRequestStatus &aRequestStatus
)

Parameters

const CMsvSearchSortQuery * aQuery
TMsvOp aOperationId
TBool aMarkQuery
TRequestStatus & aRequestStatus

SendCommandDataL(TMsvOp, const CMsvEntrySelection &, TInt, const TDesC8 &)

voidSendCommandDataL(TMsvOpaOperationId,
const CMsvEntrySelection &aSelection,
TIntaCommand,
const TDesC8 &aParameter
)[private]

Parameters

TMsvOp aOperationId
const CMsvEntrySelection & aSelection
TInt aCommand
const TDesC8 & aParameter

SendEntryDataL(TMsvOp, const TMsvEntry &)

voidSendEntryDataL(TMsvOpaOperationId,
const TMsvEntry &aEntry
)[private]

Parameters

TMsvOp aOperationId
const TMsvEntry & aEntry

SendNewResultsToServerForSortL(TMsvOp, RArray< TMsvId > &, TRequestStatus &)

voidSendNewResultsToServerForSortL(TMsvOpaOperationId,
RArray< TMsvId > &aIdArray,
TRequestStatus &aRequestStatus
)

Parameters

TMsvOp aOperationId
RArray< TMsvId > & aIdArray
TRequestStatus & aRequestStatus

SendOperationDataL(TMsvOp, const CMsvEntrySelection &, TInt, TInt)

voidSendOperationDataL(TMsvOpaOperationId,
const CMsvEntrySelection &aSelection,
TIntaParameter1 = 0,
TIntaParameter2 = 0
)[private]

Parameters

TMsvOp aOperationId
const CMsvEntrySelection & aSelection
TInt aParameter1 = 0
TInt aParameter2 = 0

SendResultantListL(TMsvOp, RArray< TMsvIdWithSortField >, TRequestStatus &)

voidSendResultantListL(TMsvOpaOperationId,
RArray< TMsvIdWithSortField >aTMsvIdWithSortField,
TRequestStatus &aRequestStatus
)

Parameters

TMsvOp aOperationId
RArray< TMsvIdWithSortField > aTMsvIdWithSortField
TRequestStatus & aRequestStatus

ServiceActive(TMsvId)

IMPORT_C TBoolServiceActive(TMsvIdaServiceId)

Parameters

TMsvId aServiceId

ServiceProgress(TMsvId, TDes8 &)

IMPORT_C TIntServiceProgress(TMsvIdaServiceId,
TDes8 &aProgress
)

Parameters

TMsvId aServiceId
TDes8 & aProgress

SetFailure(TInt, TInt, TInt, TInt)

IMPORT_C voidSetFailure(TIntaType,
TIntaArg1 = 0,
TIntaArg2 = 0,
TIntaArg3 = 0
)

Parameters

TInt aType
TInt aArg1 = 0
TInt aArg2 = 0
TInt aArg3 = 0

SetReceiveEntryEvents(TBool)

IMPORT_C TIntSetReceiveEntryEvents(TBoolaReceive)

Parameters

TBool aReceive

SetSessionAsObserver()

TInt SetSessionAsObserver()

StopService(TMsvId)

IMPORT_C TIntStopService(TMsvIdaServiceId)

Parameters

TMsvId aServiceId

TestSlotAvailableL()

voidTestSlotAvailableL()[private]

TransferCommandL(const CMsvEntrySelection &, TInt, const TDesC8 &, TMsvOp, TRequestStatus &)

IMPORT_C voidTransferCommandL(const CMsvEntrySelection &aSelection,
TIntaCommandId,
const TDesC8 &aParameter,
TMsvOpaOperationId,
TRequestStatus &aStatus
)

Parameters

const CMsvEntrySelection & aSelection
TInt aCommandId
const TDesC8 & aParameter
TMsvOp aOperationId
TRequestStatus & aStatus

TransferCommandL(const CMsvEntrySelection &, TInt, const TDesC8 &, TMsvOp)

IMPORT_C TIntTransferCommandL(const CMsvEntrySelection &aSelection,
TIntaCommandId,
const TDesC8 &aParameter,
TMsvOpaOperationId
)

Parameters

const CMsvEntrySelection & aSelection
TInt aCommandId
const TDesC8 & aParameter
TMsvOp aOperationId

UnmarkSearchSortRequestQueryIdL(TInt)

voidUnmarkSearchSortRequestQueryIdL(TIntaQueryId)

Parameters

TInt aQueryId

UseMtmGroup(TUid)

IMPORT_C TIntUseMtmGroup(TUidaMtmTypeUid)

Parameters

TUid aMtmTypeUid

Version()

IMPORT_C TVersionVersion()const

Member Data Documentation

HBufC8 * iBuffer

HBufC8 *iBuffer[private]
© Nokia 2010.