Location:
MSVSTD.H
Link against: msgs.lib
Link against: msgs_autoshutdown.lib
class CMsvEntryFilter : public CBase;
Used to query the Message Server for entries that match the specification defined in the filter.
It allows a query to be performed on service, MTM, type and last change date. The filter also enables the specification of the order in which the entries are returned.
CBase
- Base class for all classes to be instantiated on the heap
CMsvEntryFilter
- Used to query the Message Server for entries that match the specification defined in the filter
Defined in CMsvEntryFilter
:
LastChangeDate()
, Mtm()
, NewL()
, NewLC()
, Order()
, Service()
, SetLastChangeDate()
, SetMtm()
, SetOrder()
, SetService()
, SetSortMtm()
, SetType()
, SortMtm()
, Type()
Inherited from CBase
:
Delete()
,
Extension_()
,
operator new()
static IMPORT_C CMsvEntryFilter *NewLC();
Allocates and constructs a new entry filter, and leaves the pointer on the cleanup stack.
For default values, see the NewL()
function.
|
static IMPORT_C CMsvEntryFilter *NewL();
Allocates and constructs a new entry filter.
Default values are as follows:
1. service: KMsvNullIndexEntryId
2. MTM: KNullUid
3. entry type: KNullUid
4. last change date: no date
5. sort order defaults to EMsvSortByNone
These values mean that entries with any values for service, MTM, type and last change date will be returned, with no grouping or sort MTM.
|
inline TMsvId Service() const;
Gets the service ID set for the filter.
|
inline void SetService(TMsvId aServiceId);
Sets the service ID for the filter.
|
inline TUid Mtm() const;
Gets the MTM UID set for the filter.
|
inline void SetMtm(TUid aMtm);
Sets the MTM UID for the filter.
|
inline TUid Type() const;
Gets the entry type set for the filter.
|
inline void SetType(TUid aType);
Sets the entry type for the filter.
|
inline const TTime &LastChangeDate() const;
Gets the last change date set for the filter.
|
inline void SetLastChangeDate(const TTime &aLastChange);
Sets the last date change for the filter.
This is used to retrieve entries that have changed since a particular date.
|
inline const TMsvSelectionOrdering &Order() const;
Gets the selection ordering set for the filter.
|
inline void SetOrder(const TMsvSelectionOrdering &aOrder);
Sets the sort ordering for the filter.
|
inline TUid SortMtm() const;
Gets the sorting by MTM for the filter.
|
inline void SetSortMtm(TUid aSortMtm);
Sets the sorting by MTM for the filter.
|