![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
Section Contents
Applications that use this class will not work correctly on a version of EPOC earlier than ER5.
Not applicable
msvstd.h
ment.lib
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.
TMsvEntry();
TMsvEntry(const TMsvEntry& aEntry);
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.
const TMsvEntry& aEntry |
The entry to copy |
TMsvEntry& operator=(const TMsvEntry& aEntry);
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.
const TMsvEntry& aEntry |
The entry from which to assign |
TMsvEntry& |
Object after assignment |
TBool operator==(const TMsvEntry& aEntry) const;
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.
const TMsvEntry& aEntry |
The entry with which to compare |
TBool |
ETrue if the entries are equal, else EFalse |
void ExternalizeL(RWriteStream& aStream) const;
Use this function to write the object into the stream specified by aStream.
RWriteStream& aStream |
Stream to which to write |
Standard stream leave codes.
void InternalizeL(RReadStream& aStream);
Use this function to read an externalised object from the stream specified by aStream.
RReadStream& aStream |
Stream from which to read |
Standard stream leave codes.
The following functions access the values of index entry fields.
TBool Attachment() const;
Use this function to get the value of the attachment flag.
TBool |
The value of the attachment flag |
TBool Complete() const;
Use this function to get the value of the message complete flag.
TBool |
The value of the message complete flag |
TBool Connected() const;
Use this function to get the value of the remote server connection flag.
TBool |
The value of the remote server connection flag |
TBool Deleted() const;
Use this function to get the value of the .
deleted flag
TBool |
The value of the deleted flag |
TBool Failed() const;
Use this function to get the value of the message send failed flag.
TBool |
The value of the message send failed flag |
TBool Folder() const;
Use this function to get the value of the folder flag.
TBool |
The value of the folder flag |
TMsvId Id() const;
Use this function to get the value of the entry ID.
TMsvId |
The value of the entry ID |
TBool InPreparation() const;
Use this function to get the value of the in preparation flag.
TBool |
The value of the in preparation flag |
TBool MultipleRecipients() const;
Use this function to get the value of the multiple recipients flag.
TBool |
The value of the multiple recipients flag |
TBool New() const;
Use this function to get the value of the new message flag.
TBool |
The value of the new message flag |
TBool Operation() const;
Use this function to get the value of the disconnected operation queued flag.
TBool |
The value of the disconnected operation queued flag |
TBool Owner() const;
Use this function to get the value of the owner flag.
TBool |
The value of the owner flag |
TMsvId Parent() const;
Use this function to get the value of the parent ID.
TMsvId |
The value of the parent ID |
TInt PcSyncCount() const;
Use this function to get the value of the PC synchronisation field.
TInt |
The value of the PC synchronisation field |
TMsvPriority Priority() const;
Use this function to get the value of the message priority field.
TMsvPriority |
The value of the message priority field |
TBool ReadOnly() const;
Use this function to get the value of the read-only flag.
TBool |
The value of the read-only flag |
TBool StandardFolder() const;
Use this function to get the value of the standard folder flag.
TBool |
The value of the standard folder flag |
TBool Store() const;
Use this function to get the value of the message store flag.
TBool |
The value of the message store flag |
TBool Unread() const;
Use this function to get the value of the message unread flag.
TBool |
The value of the message unread flag |
TBool Visible() const;
Use this function to get the value of the entry visible flag.
TBool |
The value of the entry visible flag |
The following functions can be used to set the values of index entry fields.
void DecPcSyncCount();
Use this function to decrement the PC synchronisation field.
void IncPcSyncCount();
Use this function to increment the PC synchronisation field.
void SetAttachment(TBool aAttachmentFlag);
Use this function to set the attachment flag.
TBool aAttachmentFlag |
Value for the attachment flag |
void SetComplete(TBool aComplete);
Use this function to set the message complete flag.
TBool aComplete |
Value for the message complete flag |
void SetConnected(TBool aConnected);
Use this function to set the remote server connection flag.
TBool aConnected |
Value for the remote server connection flag |
void SetFailed(TBool aFailed);
Use this function to set the message send failed flag.
TBool aFailed |
Value for the message send failed flag |
void SetInPreparation(TBool aInPreparation);
Use this function to set the in-preparation flag.
TBool aInPreparation |
Value for the in-preparation flag |
void SetMultipleRecipients(TBool aMultipleRecipients);
Use this function to set the multiple recipients flag.
TBool aMultipleRecipients |
Value for the multiple recipients flag |
void SetNew(TBool aNew);
Use this function to set the message new flag.
TBool aNew |
Value for the message new flag |
void SetOperation(TBool aOperation);
Use this function to set the disconnected operation queued flag.
TBool aOperation |
Value for the disconnected operation queued flag |
void SetPriority(TMsvPriority aPriority);
Use this function to set the message priority.
TMsvPriority aPriority |
Value for the message priority |
void SetReadOnly(TBool aReadOnly);
Use this function to set the read-only flag.
TBool aReadOnly |
Value for the read-only flag |
void SetStandardFolder(TBool aStandardFolder);
Use this function to set the standard folder flag.
TBool aStandardFolder |
Value for the standard folder flag |
void SetUnread(TBool aRead);
Use this function to set the message unread flag.
TBool aRead |
Value for the message unread flag |
void SetVisible(TBool aVisible);
Use this function to set the entry visible flag.
TBool aVisible |
Value for the entry visible flag |
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 |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |
![]() |