RMsgStoreSortCriteria Class Reference

class RMsgStoreSortCriteria

This class represents the criteria for a sorting request

Public Member Functions
IMPORT_C void AddResultPropertyL (const TDesC8 &)
IMPORT_C void Close ()
const RPointerArray < TDesC8 > & PropertyKeys ()
Public Attributes
TMsgStoreId iFolderId
TMsgStoreSortOrder iSecondarySortOrder
TMsgStoreSortByField iSortBy
TMsgStoreSortOrder iSortOrder
Private Attributes
RPointerArray < TDesC8 > iPropertyKeys

Member Functions Documentation

AddResultPropertyL(const TDesC8 &)

IMPORT_C void AddResultPropertyL ( const TDesC8 & aPropertyKey )

Call this method to repeatly to specfy all the properties that the sorting result should include.

For example, in the folder view, the UI may only want to display "sender", "subject", "received date", and "flags", and not to display the rest of the properties. In this case, only add KMsgStorePropertySender, KMsgStorePropertySubject, KMsgStorePropertyReceivedAt, and KMsgStorePropertyFlags to this list and the sorted results will only include these properties.


const TDesC8 & aPropertyKey


IMPORT_C void Close ( )

Close() must be called before this object goes out of scope


const RPointerArray < TDesC8 > & PropertyKeys ( ) [inline]

Internal use only, not exported

Member Data Documentation

TMsgStoreId iFolderId

TMsgStoreId iFolderId

Specifies the folder in which the sorting is to be perform

RPointerArray< TDesC8 > iPropertyKeys

RPointerArray < TDesC8 > iPropertyKeys [private]

TMsgStoreSortOrder iSecondarySortOrder

TMsgStoreSortOrder iSecondarySortOrder

When the iSortBy field is not EMsgStoreSortByReceivedDate, the received date becomes secondary sorting field. This specifies whether the secondary should be ascending or descending

TMsgStoreSortByField iSortBy

TMsgStoreSortByField iSortBy

Specifies the sort field

TMsgStoreSortOrder iSortOrder

TMsgStoreSortOrder iSortOrder

Specifies the sort order