![[Index]](../../../../a_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../a_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../a_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../a_stock/btn_next_wt.gif){kind=small}
|
|
|
|
|
|
||
Location:
MSVSTD.H
Link against: msgs.lib
Link against: msgs_autoshutdown.lib
class TMsvEntry;
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.
Defined in TMsvEntry:
Attachment(), Complete(), Connected(), DecPcSyncCount(), DeleteProtected(), Deleted(), ExternalizeL(), Failed(), Forwarded(), Id(), InPreparation(), IncPcSyncCount(), InternalizeL(), LocallyDeleted(), MtmData1(), MtmData2(), MtmData3(), MultipleRecipients(), New(), OffPeak(), Operation(), Owner(), Parent(), PcSyncCount(), PendingConditions(), PendingDelete(), PermanentDataUnchanged(), PersistedFlags(), Priority(), ReadOnly(), Scheduled(), SendingState(), SetAttachment(), SetComplete(), SetConnected(), SetDeleteProtected(), SetDeleted(), SetFailed(), SetForwarded(), SetId(), SetInPreparation(), SetLocallyDeleted(), SetMultipleRecipients(), SetNew(), SetOffPeak(), SetOperation(), SetOwner(), SetParent(), SetPendingConditions(), SetPendingDelete(), SetPriority(), SetReadOnly(), SetScheduled(), SetSendingState(), SetStandardFolder(), SetUnread(), SetVisible(), StandardFolder(), TMsvEntry(), TMsvEntry(), TemporaryFlags(), Unread(), Visible(), iBioType, iDate, iDescription, iDetails, iError, iMtm, iMtmData1, iMtmData2, iMtmData3, iRelatedId, iServiceId, iSize, iType, operator=(), operator==()
IMPORT_C TMsvEntry();
Default constructor.
Initialises the new object to null values: 0 for integer values, KMsvNullIndexEntryId for IDs, and KUidMsvNullEntry for UIDs.
IMPORT_C TMsvEntry(const TMsvEntry &aEntry);
Copy constructor.
It 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.
|
|
|
IMPORT_C TMsvEntry &operator=(const TMsvEntry &aEntry);
Overloaded assignment operator.
This 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.
|
|
IMPORT_C TBool operator==(const TMsvEntry &aEntry) const;
Overloaded equality operator.
This 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.
|
|
IMPORT_C TBool PermanentDataUnchanged(const TMsvEntry &aEntry) const;
Compares if the flag settings in two index entries are the same. The Connected and Pending Delete flags are not used in the comparison, as they indicate temporary conditions of the entry.
|
|
IMPORT_C TMsvPriority Priority() const;
Gets the value of the message priority field.
|
IMPORT_C void SetPriority(TMsvPriority aPriority);
Sets the message priority.
|
IMPORT_C void InternalizeL(RReadStream &aStream);
Reads an externalised object from the specified stream.
|
IMPORT_C void ExternalizeL(RWriteStream &aStream) const;
Writes the object into the stream specified.
|
inline TMsvId Id() const;
Gets the value of the entry ID.
|
inline TMsvId Parent() const;
Gets the value of the parent ID.
|
inline TBool Owner() const;
Gets the value of the owner flag.
|
inline TBool Deleted() const;
Gets the value of the deleted flag.
|
inline TBool Complete() const;
Gets the value of the message complete flag.
Note that for email download without size limits, the complete flag will only be set to true once all the parts of the message (body text and attachments) have been downloaded.
|
inline void SetComplete(TBool aComplete);
Sets the message complete flag.
Note that for email download without size limits, the complete flag will only be set to true once all the parts of the message (body text and attachments) have been downloaded.
|
inline TBool New() const;
Gets the value of the new message flag.
|
inline void SetNew(TBool aNew);
Sets the message new flag.
|
inline TBool Unread() const;
Gets the value of the message unread flag.
|
inline void SetUnread(TBool aUnread);
Sets the message unread flag.
|
inline TBool Failed() const;
Gets the value of the message send failed flag.
|
inline void SetFailed(TBool aFailed);
Sets the message send failed flag.
|
inline TBool Operation() const;
Gets the value of the disconnected operation queued flag.
|
inline void SetOperation(TBool aOperation);
Sets the disconnected operation queued flag.
|
inline TBool Visible() const;
Gets the value of the entry visible flag.
|
inline void SetVisible(TBool aVisble);
Sets the entry visible flag.
|
inline TBool MultipleRecipients() const;
Gets the value of the multiple recipients flag.
|
inline void SetMultipleRecipients(TBool aMultipleRecipient);
Sets the multiple recipients flag.
|
inline TBool ReadOnly() const;
Gets the value of the read-only flag.
|
inline void SetReadOnly(TBool aReadOnly);
Sets the read-only flag.
|
inline TBool StandardFolder() const;
Gets the value of the standard folder flag.
|
inline TBool Attachment() const;
Gets the value of the attachment flag.
|
inline void SetAttachment(TBool aAttachmentFlag);
Sets the attachment flag.
|
inline TBool Connected() const;
Gets the value of the remote server connection flag.
|
inline void SetConnected(TBool aConnected);
Sets the remote server connection flag.
|
inline TBool InPreparation() const;
Gets the value of the in preparation flag.
|
inline void SetInPreparation(TBool aInPreparation);
Sets the in-preparation flag.
|
inline TInt PcSyncCount() const;
Gets the value of the PC synchronisation field.
|
inline TBool OffPeak() const;
Gets the off-peak flag.
|
inline void SetOffPeak(TBool aOffPeak);
Sets the off-peak flag.
|
inline TBool Scheduled() const;
Gets the scheduled flag.
|
inline void SetScheduled(TBool aScheduled);
Sets the scheduled flag.
|
inline TUint SendingState() const;
Gets the sending state.
|
inline void SetSendingState(TUint aSendingState);
Sets the sending state.
|
inline void SetDeleteProtected(TBool aDeleteProtected);
This method sets bit 24 of iMtmData1, if you are using this bit elsewhere don't call this method.
|
inline TBool DeleteProtected() const;
returns the delete protected state
|
inline void SetForwarded(TBool aForwarded);
This method sets bit 31 of iMtmData1, if you are using this bit elsewhere don't call this method.
|
inline void SetLocallyDeleted(TBool aLocallyDeleted);
This method sets bit 32 of iMtmData1, if you are using this bit elsewhere don't call this method.
|
inline TBool LocallyDeleted() const;
returns the locally deleted state
|
IMPORT_C TBool PendingConditions() const;
Gets the pending conditions flag.
|
IMPORT_C void SetPendingConditions(TBool aPendingConditions);
Sets the pending conditions flag.
|
IMPORT_C TInt32 MtmData1() const;
Gets the integer value of iMtmData1
|
IMPORT_C TInt32 MtmData2() const;
Gets the integer value of iMtmData2
|
IMPORT_C TInt32 MtmData3() const;
Gets the integer value of iMtmData3
|
|
|
TInt32 iMtmData1;
MTM data 1: this can be used for any purpose by an MTM. This member must only be accessed through the predefined set and get functions. If you must write data to a bit that has no meaning in the predefined derived classes then you must derive your own class from TMsvEntry.
TInt32 iMtmData2;
MTM data 2: this can be used for any purpose by an MTM. This member must only be accessed through the predefined set and get functions. If you must write data to a bit that has no meaning in the predefined derived classes then you must derive your own class from TMsvEntry.
TInt32 iMtmData3;
MTM data 3: this can be used for any purpose by an MTM. This member must only be accessed through the predefined set and get functions. If you must write data to a bit that has no meaning in the predefined derived classes then you must derive your own class from TMsvEntry.
TPtrC iDetails;
Details
|
Copyright ©2008 Symbian Software Ltd. |
|
![[Top]](../../../../a_stock/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/btn_prev.gif){kind=small}
![[Top]](../../../../a_stock/btn_top.gif)
![[Next]](../../../../a_stock/btn_next.gif){kind=small}