EPOC   SDK Home Glossary Indexes Previous Next Up

TMsvEntry class


Contents


TMsvEntry class — Index entry

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

Not applicable

Defined in

msvstd.h

Link against

ment.lib

Description

This class represents an entry in the Message Server index. MTM implementations and message client applications use it to access and manipulate index entry values. Note that a TMsvEntry is effectively a local cache of the index entry, and changes to it are not automatically written into the index. To commit changes to the Message Server, you need to call CMsvEntry::ChangeL().

To avoid repetition, the functions and data members are simply listed here, without detailed explanation of the fields: for that, see Index entry fields.


Constructors


TMsvEntry() — Constructors

TMsvEntry();

TMsvEntry(const TMsvEntry& aEntry);

Description

The simple constructor initialises the new object to null values: 0 for integer values, KMsvNullIndexEntryId for IDs, and KUidMsvNullEntry for UIDs.

The copy constructor makes a simple copy of aEntry, so the TPtrC members iDescription and iDetails will point to the same descriptor data in the original and new objects.

Arguments

const TMsvEntry& aEntry

The entry to copy


Equality and assignment


operator=() — Assignment operator

TMsvEntry& operator=(const TMsvEntry& aEntry);

Description

The overloaded assignment operator acts similarly to the copy constructor: i.e. it makes a simple copy of aEntry, so the TPtrC members iDescription and iDetails will point to the same descriptor data in the original and new objects.

Arguments

const TMsvEntry& aEntry

The entry from which to assign

Return value

TMsvEntry&

Object after assignment


operator==() — Equality operator

TBool operator==(const TMsvEntry& aEntry) const;

Description

The overloaded equality operator returns ETrue if the fields of aEntry are equal to those of the object. The contents, rather than pointer values, of the TPtrC members are compared.

Arguments

const TMsvEntry& aEntry

The entry with which to compare

Return value

TBool

ETrue if the entries are equal, else EFalse


Internalising and externalising


ExternalizeL() — Externalise

void ExternalizeL(RWriteStream& aStream) const;      

Description

Use this function to write the object into the stream specified by aStream.

Arguments

RWriteStream& aStream

Stream to which to write

Leave considerations

Standard stream leave codes.


InternalizeL() — Internalise

void InternalizeL(RReadStream& aStream);

Description

Use this function to read an externalised object from the stream specified by aStream.

Arguments

RReadStream& aStream

Stream from which to read

Leave considerations

Standard stream leave codes.


Accessors

The following functions access the values of index entry fields.


Attachment() — Attachment flag

TBool Attachment() const;

Description

Use this function to get the value of the attachment flag.

Return value

TBool

The value of the attachment flag


Complete() — Message complete flag

TBool Complete() const;

Description

Use this function to get the value of the message complete flag.

Return value

TBool

The value of the message complete flag


Connected() — Remote server connection flag

TBool Connected() const;

Description

Use this function to get the value of the remote server connection flag.

Return value

TBool

The value of the remote server connection flag


Deleted() — Deleted flag

TBool Deleted() const;

Description

Use this function to get the value of the .

deleted flag

Return value

TBool

The value of the deleted flag


Failed() — Message send failed flag

TBool Failed() const;

Description

Use this function to get the value of the message send failed flag.

Return value

TBool

The value of the message send failed flag


Folder() — Folder flag

TBool Folder() const;

Description

Use this function to get the value of the folder flag.

Return value

TBool

The value of the folder flag


Id() — Entry ID

TMsvId Id() const;

Description

Use this function to get the value of the entry ID.

Return value

TMsvId

The value of the entry ID


InPreparation() — In preparation flag

TBool InPreparation() const;

Description

Use this function to get the value of the in preparation flag.

Return value

TBool

The value of the in preparation flag


MultipleRecipients() — Multiple recipients flag

TBool MultipleRecipients() const;

Description

Use this function to get the value of the multiple recipients flag.

Return value

TBool

The value of the multiple recipients flag


New() — New message flag

TBool New() const;

Description

Use this function to get the value of the new message flag.

Return value

TBool

The value of the new message flag


Operation() — Disconnected operation queued flag

TBool Operation() const;

Description

Use this function to get the value of the disconnected operation queued flag.

Return value

TBool

The value of the disconnected operation queued flag


Owner() — Owner flag

TBool Owner() const;

Description

Use this function to get the value of the owner flag.

Return value

TBool

The value of the owner flag


Parent() — Parent ID

TMsvId Parent() const;

Description

Use this function to get the value of the parent ID.

Return value

TMsvId

The value of the parent ID


PcSyncCount() — PC synchronisation

TInt PcSyncCount() const;

Description

Use this function to get the value of the PC synchronisation field.

Return value

TInt

The value of the PC synchronisation field


Priority() — Message priority

TMsvPriority Priority() const;

Description

Use this function to get the value of the message priority field.

Return value

TMsvPriority

The value of the message priority field


ReadOnly() — Read-only flag

TBool ReadOnly() const;

Description

Use this function to get the value of the read-only flag.

Return value

TBool

The value of the read-only flag


StandardFolder() — Standard folder flag

TBool StandardFolder() const;

Description

Use this function to get the value of the standard folder flag.

Return value

TBool

The value of the standard folder flag


Store() — Message store flag

TBool Store() const;

Description

Use this function to get the value of the message store flag.

Return value

TBool

The value of the message store flag


Unread() — Message unread flag

TBool Unread() const;

Description

Use this function to get the value of the message unread flag.

Return value

TBool

The value of the message unread flag


Visible() — Entry visible flag

TBool Visible() const;

Description

Use this function to get the value of the entry visible flag.

Return value

TBool

The value of the entry visible flag


Mutators

The following functions can be used to set the values of index entry fields.


DecPcSyncCount() — Decrement PC synchronisation field

void DecPcSyncCount();

Description

Use this function to decrement the PC synchronisation field.


IncPcSyncCount() — Increment PC synchronisation field

void IncPcSyncCount();

Description

Use this function to increment the PC synchronisation field.


SetAttachment() — Attachment flag

void SetAttachment(TBool aAttachmentFlag);

Description

Use this function to set the attachment flag.

Arguments

TBool aAttachmentFlag

Value for the attachment flag

      


SetComplete() — Message complete flag

void SetComplete(TBool aComplete);

Description

Use this function to set the message complete flag.

Arguments

TBool aComplete

Value for the message complete flag


SetConnected() — Remote server connection flag

void SetConnected(TBool aConnected);

Description

Use this function to set the remote server connection flag.

Arguments

TBool aConnected

Value for the remote server connection flag


SetFailed() — Message send failed flag

void SetFailed(TBool aFailed);

Description

Use this function to set the message send failed flag.

Arguments

TBool aFailed

Value for the message send failed flag


SetInPreparation() — In-preparation flag

void SetInPreparation(TBool aInPreparation);

Description

Use this function to set the in-preparation flag.

Arguments

TBool aInPreparation

Value for the in-preparation flag


SetMultipleRecipients() — Multiple recipients flag

void SetMultipleRecipients(TBool aMultipleRecipients);       

Description

Use this function to set the multiple recipients flag.

Arguments

TBool aMultipleRecipients

Value for the multiple recipients flag


SetNew() — Message new flag

void SetNew(TBool aNew);

Description

Use this function to set the message new flag.

Arguments

TBool aNew

Value for the message new flag


SetOperation() — Disconnected operation queued flag

void SetOperation(TBool aOperation);

Description

Use this function to set the disconnected operation queued flag.

Arguments

TBool aOperation

Value for the disconnected operation queued flag


SetPriority() — Message priority

void SetPriority(TMsvPriority aPriority);

Description

Use this function to set the message priority.

Arguments

TMsvPriority aPriority

Value for the message priority


SetReadOnly() — Read-only flag

void SetReadOnly(TBool aReadOnly);

Description

Use this function to set the read-only flag.

Arguments

TBool aReadOnly

Value for the read-only flag


SetStandardFolder() — Standard folder flag

void SetStandardFolder(TBool aStandardFolder);

Description

Use this function to set the standard folder flag.

Arguments

TBool aStandardFolder

Value for the standard folder flag


SetUnread() — Message unread flag

void SetUnread(TBool aRead);

Description

Use this function to set the message unread flag.

Arguments

TBool aRead

Value for the message unread flag


SetVisible() — Entry visible flag

void SetVisible(TBool aVisible);

Description

Use this function to set the entry visible flag.

Arguments

TBool aVisible

Value for the entry visible flag


Public member data

The following public data members can be used to get and set the values of index entry fields.

Data member

Field

TTime iDate

Time

TPtrC iDescription

Description

TPtrC iDetails

Details

TInt32 iError

Error

TUid iMtm

MTM

TInt32 iMtmData1

MTM data 1

TInt32 iMtmData2

MTM data 2

TInt32 iMtmData3

MTM data 3

TMsvId iRelatedId

Related folder ID

TMsvId iServiceId

Service ID

TInt32 iSize

Size

TUid iType

Entry type

TInt32 iWdpPortNumber

Port number

EPOC       SDK Home Glossary Indexes Previous Next Up