EPOC   SDK Home Glossary Indexes Previous Next Up

Index entry fields


Contents

The index entry fields provide a simple and generic way for MTMs to provide information about an entry to a user interface. A few fields, such as that for the ID, are controlled by the Message Server. Most, however, are set by MTMs. Some fields are specific to some entry types (i.e. service, folder, message, or binary file). The interpretation of some other fields varies with the type.


Attachment flag

Description

An indication to any UI that the entry has an attachment associated with it. If a message has an associated binary file used for some other purpose than a message attachment, the flag should not be set.

This is only appropriate for a message context.

Values

Boolean flag

Access

TMsvEntry::Attachment()

Mutate

TMsvEntry::SetAttachment()

Default

EFalse


Deleted flag

Description

Indicates that this entry has been deleted. It cannot be totally removed until any PC synchronisation has been informed of the deletion.

Values

Boolean flag

Access

TMsvEntry::Deleted()

Mutate

None

Default

EFalse


Description

Description

A text string describing the entry. For a message, this is interpreted as the message subject.

Values

TPtrC

Access

TMsvEntry::iDescription

Mutate

TMsvEntry::iDescription

Default

Empty string


Details

Description

A text string detailing the entry. The contents vary with the type of entry:

message: for received messages, the sender’s name; for outgoing messages, the recipient’s name

attachment: the name of the attachment (e.g. word.doc)

folder: the name of the folder

service: the name of the service

Values

TPtrC

Access

TMsvEntry::iDetails

Mutate

TMsvEntry::iDetails

Default

Empty string


Disconnected operation queued flag

Description

Some MTMs may accept operations that are only actually performed when going online at a later time. This flag indicates that such a disconnected operation has been queued for this entry.

Values

Boolean flag

Access

TMsvEntry::Operation()

Mutate

TMsvEntry::SetOperation()

Default

EFalse


Entry type

Description

The type of entry: i.e. service, folder, message, or attachment. For the UID values, see Entry type constants.

Values

TUid

Access

TMsvEntry::iType

Mutate

TMsvEntry::iType

Default

KUidMsvNullEntry


Entry visible flag

Description

Indicates whether the UI should show this entry. For example, binary files that are not attachments are commonly made invisible.

Values

Boolean flag

Access

TMsvEntry::Visible()

Mutate

TMsvEntry::SetVisible()

Default

EFalse


Error

Description

Records an error code. The use and meaning of this is MTM dependent.

Values

TInt32

Access

TMsvEntry::iError

Mutate

TMsvEntry::iError

Default

KErrNone


Failed flag

Description

For an outgoing message, indicates that the sending failed.

Values

Boolean flag

Access

TMsvEntry::Failed()

Mutate

TMsvEntry::SetFailed()

Default

EFalse


Folder flag

Description

A folder containing binary files associated with this entry has been created. This flag being true does not necessarily mean that there are binary files. Clients can only read this flag.

Values

Boolean flag

Access

TMsvEntry::Folder()

Mutate

None

Default

EFalse


ID

Description

Identifier for the entry. It is allocated by the Message Server, and can only be read by clients.

Values

TMsvId

Access

TMsvEntry::Id()

Mutate

None

Default

KMsvNullIndexEntryId


In-preparation flag

Description

This flag can be set for entries that are being prepared: for example, while a new message is being created in a message editor. User interfaces should not display entries with this flag set. The flag should be cleared when creation is complete.

The Message Server provides some automatic cleanup by deleting entries with this flag set when it starts.

Values

Boolean flag

Access

TMsvEntry::InPreparation()

Mutate

TMsvEntry::SetInPreparation()

Default

EFalse


Message complete flag

Description

For a message, indicates that it is complete. This means that it is ready for transfer: e.g. for a fax, that it has been rendered.

Values

Boolean flag

Access

TMsvEntry::Complete()

Mutate

TMsvEntry::SetComplete()

Default

EFalse


Message store flag

Description

Indicate that an entry has a corresponding message store. This flag is read-only to clients.

Values

Boolean flag

Access

TMsvEntry::Store()

Mutate

None

Default

EFalse


Message unread flag

Description

For a message or attachment, indicates that it is unread.

Values

Boolean flag

Access

TMsvEntry::Unread()

Mutate

TMsvEntry::SetUnread()

Default

EFalse


Message priority

Description

Standard values are in the enumeration TMsvPriority. Clients may set this value. The use made of this value is MTM-specific.

Values

TMsvPriority

Access

TMsvEntry::Priority()

Mutate

TMsvEntry::SetPriority()

Default

EMsvMediumPriority


MTM

Description

For messages and services, used to indicate the associated MTM, identified by its UID.

Values

TUid

Access

TMsvEntry::iMtm

Mutate

TMsvEntry::iMtm

Default

KUidMsvNullEntry


MTM data 1, MTM data 2, MTM data 3

Description

These fields are reserved for use by the MTMs, so that limited information can be stored in the entry for use by the MTM. This is intended to reduce the frequency of opening the message store.

Values

TInt32

Access

TMsvEntry::iMtmData1,iMtmData2,iMtmData3

Mutate

TMsvEntry::iMtmData1,iMtmData2,iMtmData3

Default

0


Multiple recipients flag

Description

Indicates the message has multiple recipients that require separate transmissions (e.g. a fax going to two numbers, but not a email going to several recipients).

Values

Boolean flag

Access

TMsvEntry::MultipleRecipients()

Mutate

TMsvEntry::SetMultipleRecipients()

Default

EFalse


New message flag

Description

For a message, indicates that it is new.

Values

Boolean flag

Access

TMsvEntry::New()

Mutate

TMsvEntry::SetNew()

Default

EFalse


Owner flag

Description

Indicates that an entry owns other entries (that it is a parent). This flag is read-only to clients.

Values

Boolean flag

Access

TMsvEntry::Owner()

Mutate

None

Default

EFalse


Parent ID

Description

The ID of the parent of the entry. This flag is read-only to clients.

Values

TMsvId

Access

TMsvEntry::Parent()

Mutate

None

Default

KMsvNullIndexEntryId


PC synchronisation

Description

The PC synchroniser count records the number of synchronisers that know about this entry.

Values

TInt

Access

TMsvEntry::PcSyncCount()

Mutate

TMsvEntry::DecPcSyncCount(), TMsvEntry::IncPcSyncCount()

Default

0


Port number

Description

Used to record the port number for smart messages.

Values

TInt32

Access

TMsvEntry::iWdpPortNumber

Mutate

TMsvEntry::iWdpPortNumber

Default

0


Read-only flag

Description

Indicates that the entry is read only: any associated message store can only be read.

Values

Boolean flag

Access

TMsvEntry::ReadOnly()

Mutate

TMsvEntry::SetReadOnly()

Default

EFalse


Related folder ID

Description

The ID of a target folder for copying or moving entries.

Values

TMsvId

Access

TMsvEntry::iRelatedId

Mutate

TMsvEntry::iRelatedId

Default

KMsvNullIndexEntryId


Remote server connection flag

Description

For services, indicates whether it is currently connected to a remote server.

Values

Boolean flag

Access

TMsvEntry::Connected()

Mutate

TMsvEntry::SetConnected()

Default

EFalse


Service ID

Description

The ID of the service over which a message was received or is to be sent.

Values

TMsvId

Access

TMsvEntry::iServiceId

Mutate

TMsvEntry::iServiceId

Default

KMsvNullIndexEntryId


Size

Description

The size of the message. For messages held on a remote server, it is the remote size, rather than the local size.

Values

TInt32

Access

TMsvEntry::iSize

Mutate

TMsvEntry::iSize

Default

0


Standard folder flag

Description

When sorting entries, it is possible to have entries marked with this flag placed at the start of the list. This is usually only used for the standard folders (Inbox, Outbox, Draft, Sent).

Values

Boolean flag

Access

TMsvEntry::StandardFolder()

Mutate

TMsvEntry::SetStandardFolder()

Default

EFalse


Time

Description

The time the message was last acted upon (e.g. created, edited, received).

Values

TTime

Access

TMsvEntry::iDate

Mutate

TMsvEntry::iDate

Default

Uninitialised

EPOC       SDK Home Glossary Indexes Previous Next Up