![[Index]](../../../stock/btn_index.gif){kind=small}
![[Glossary]](../../../stock/btn_glossary.gif){kind=small}
![[Previous]](../../../stock/btn_prev.gif){kind=small}
![[Next]](../../../stock/btn_next.gif){kind=small}
| |
|
| |
Location:
msvstd.h
Link against:
msgs.lib
TMsvEntry
Supported from 5.0
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() (or CMsvServerEntry::ChangeEntry()).
To avoid repetition, the functions and data members are simply listed here, without detailed explanation of the fields. The public data members can be used to get and set the values of some index entry fields.
In pre-Unicode versions this class had an import library ment.lib.
Defined in TMsvEntry:
Attachment(), Complete(), Connected(), DecPcSyncCount(), Deleted(), ExternalizeL(), Failed(), Folder(), Id(), InPreparation(), IncPcSyncCount(), InternalizeL(), MultipleRecipients(), New(), OffPeak(), Operation(), Owner(), Parent(), PcSyncCount(), Priority(), ReadOnly(), Scheduled(), SendingState(), SetAttachment(), SetComplete(), SetConnected(), SetFailed(), SetInPreparation(), SetMultipleRecipients(), SetNew(), SetOffPeak(), SetOperation(), SetPriority(), SetReadOnly(), SetScheduled(), SetSendingState(), SetStandardFolder(), SetUnread(), SetVisible(), StandardFolder(), Store(), TMsvEntry(), Unread(), Visible(), iBioType, iDate, iDescription, iDetails, iError, iMtm, iMtmData1, iMtmData2, iMtmData3, iRelatedId, iServiceId, iSize, iType, iWdpPortNumber, operator=(), operator==()
TMsvEntry();
Initialises the new object to null values: 0 for integer values, KMsvNullIndexEntryId for IDs, and KUidMsvNullEntry for UIDs.
TMsvEntry(const TMsvEntry& aEntry);
Creates a simple copy of the entry, so the TPtrC members iDescription and iDetails will point to the same descriptor data in the original and new objects.
|
|
TMsvEntry& operator=(const TMsvEntry& aEntry);
Acts similarly to the copy constructor: i.e. it makes a simple copy of entry, so the TPtrC entry description and details members will point to the same descriptor data in the original and new objects.
|
|
TBool operator==(const TMsvEntry& aEntry) const;
Tests whether the fields of the specified entry are equal to those of this object. The contents, rather than pointer values, of the TPtrC members are compared.
|
|
|
void ExternalizeL(RWriteStream& aStream) const;
Writes the object into the stream specified.
|
|
void InternalizeL(RReadStream& aStream);
Reads an externalised object from the specified stream.
|
|
|
TBool Attachment() const;
Gets the value of the attachment flag.
|
TBool Complete() const;
Gets the value of the message complete flag.
|
TBool Connected() const;
Gets the value of the remote server connection flag.
|
TBool Deleted() const;
Gets the value of the deleted flag.
|
TBool Failed() const;
Gets the value of the message send failed flag.
|
TBool Folder() const;
Withdrawn in 5.1
Gets the value of the folder flag.
For Unicode EPOC releases, the folder flag does not exist. Equivalent functionality can be obtained through CMsvEntry::HasDirectoryL().
|
TMsvId Id() const;
Gets the value of the entry ID.
|
TBool InPreparation() const;
Gets the value of the in preparation flag.
|
TBool MultipleRecipients() const;
Gets the value of the multiple recipients flag.
|
TBool New() const;
Gets the value of the new message flag.
|
TBool OffPeak() const;
Supported from 6.0
Gets the off-peak flag.
|
TBool Operation() const;
Gets the value of the disconnected operation queued flag.
|
TBool Owner() const;
Gets the value of the owner flag.
|
TMsvId Parent() const;
Gets the value of the parent ID.
|
TInt PcSyncCount() const;
Gets the value of the PC synchronisation field.
|
TMsvPriority Priority() const;
Gets the value of the message priority field.
|
TBool ReadOnly() const;
Gets the value of the read-only flag.
|
TBool Scheduled() const;
Supported from 6.0
Gets the scheduled flag.
|
TInt SendingState() const;
Supported from 6.0
Gets the sending state.
|
TBool StandardFolder() const;
Gets the value of the standard folder flag.
|
TBool Store() const;
Withdrawn in 5.1
Tests the value of the message store flag.
For Unicode releases, the message store flag does not exist. Equivalent functionality can be obtained through CMsvEntry::HasStoreL().
|
TBool Unread() const;
Gets the value of the message unread flag.
|
TBool Visible() const;
Gets the value of the entry visible flag.
|
|
void SetAttachment(TBool aAttachmentFlag);
Sets the attachment flag.
|
void SetComplete(TBool aComplete);
Sets the message complete flag.
|
void SetConnected(TBool aConnected);
Sets the remote server connection flag.
|
void SetFailed(TBool aFailed);
Sets the message send failed flag.
|
void SetInPreparation(TBool aInPreparation);
Sets the in-preparation flag.
|
void SetMultipleRecipients(TBool aMultipleRecipients);
Sets the multiple recipients flag.
|
void SetNew(TBool aNew);
Sets the message new flag.
|
void SetOffPeak(TBool aOffPeak);
Supported from 6.0
Sets the off-peak flag.
|
void SetOperation(TBool aOperation);
Sets the disconnected operation queued flag.
|
void SetPriority(TMsvPriority aPriority);
Sets the message priority.
|
void SetReadOnly(TBool aReadOnly);
Sets the read-only flag.
|
void SetScheduled(TBool aScheduled);
Supported from 6.0
Sets the scheduled flag.
|
void SetSendingState(TInt aSendingState) const;
Supported from 6.0
Sets the sending state.
|
void SetStandardFolder(TBool aStandardFolder);
Sets the standard folder flag.
|
void SetUnread(TBool aRead);
Sets the message unread flag.
|
void SetVisible(TBool aVisible);
Sets the entry visible flag.
|
|
TInt32 iBioType
Supported from 6.0
BIO message type
Copyright ©2002 Symbian Ltd. 6.1-00174 |
|
![[Top]](../../../stock/arrow_up_2.gif){kind=icon}
![[Top]](../../../stock/arrow_up.gif){kind=icon}