Location:
LOGCLI.H
Link against: logcli.lib
class CLogFilter : public CBase;
Specifies the conditions that events must satisfy to appear in a view.
In general, a filter is used to construct the WHERE clause of an SQL statement based on the content of the filter's fields.
The filter's fields correspond to the event properties in a log event detail object, i.e. an instance of the CLogEvent
class.
Where a filter uses time to extract one or more events from the log, this must be specified as UTC rather than local time.
CBase
- Base class for all classes to be instantiated on the heap
CLogFilter
- Specifies the conditions that events must satisfy to appear in a view
Defined in CLogFilter
:
ClearFlags()
, Contact()
, Copy()
, Direction()
, DurationType()
, EndTime()
, EventType()
, Flags()
, NewL()
, NullFields()
, Number()
, RemoteParty()
, SetContact()
, SetDirection()
, SetDurationType()
, SetEndTime()
, SetEventType()
, SetFlags()
, SetNullFields()
, SetNumber()
, SetRemoteParty()
, SetStartTime()
, SetStatus()
, StartTime()
, Status()
, ~CLogFilter()
Inherited from CBase
:
Delete()
,
Extension_()
,
operator new()
static IMPORT_C CLogFilter *NewL();
Creates a new filter object.
All fields in the new instance are initialised to default values, so that if none of the fields are changed, the filter has no effect on the selection of events in view.
|
IMPORT_C ~CLogFilter();
Frees all resource owned by the object prior to its destruction.
inline TUid EventType() const;
Gets the event type used by the filter.
|
inline void SetEventType(TUid aType);
Sets the event type to be used by the filter.
|
inline const TDesC &RemoteParty() const;
Gets the remote party string used by the filter.
|
inline void SetRemoteParty(const TDesC &aRemote);
Sets the remote party string to be used by the filter.
|
inline const TDesC &Direction() const;
Gets the direction string used by the filter.
|
inline void SetDirection(const TDesC &aDirection);
Sets the direction string to be used by the filter.
|
inline TLogDurationType DurationType() const;
Gets the duration type used by the filter.
|
inline void SetDurationType(TLogDurationType aType);
Sets the duration type to be used by the filter.
|
inline const TDesC &Status() const;
Gets the delivery status used by the filter.
|
inline void SetStatus(const TDesC &aStatus);
Sets the delivery status to be used by the filter.
|
inline TLogContactItemId Contact() const;
Gets the contact ID used by the filter.
|
inline void SetContact(TLogContactItemId aContact);
Sets the contact ID to be used by the filter.
|
inline const TDesC &Number() const;
Gets the phone number used by the filter.
|
inline void SetNumber(const TDesC &aNumber);
Sets the phone number to be used by the filter.
|
inline TLogFlags Flags() const;
Gets the flags used by the filter.
|
inline void SetFlags(TLogFlags aFlags);
Sets the specified flags to be used by the filter.
|
inline void ClearFlags(TLogFlags aFlags);
Clears the specified flags to be used by the filter.
The constant KLogFlagsMask can be used to clear all the flags.
|
inline TUint32 NullFields() const;
Identifies the fields defined as NULL in the filter. These are the fields that the filter expects to be NULL in the database. A NULL field is one that has no value.
|
inline void SetNullFields(TUint32 aFields);
Defines NULL fields to the filter. These are the fields that the filter expects to be NULL in the database. A NULL field is one that has no value.
Each field is identified by a bit value. The bit values may be ORd together in any combination.
Note that setting a flag and explicitly setting a value for the corresponding field generates an OR condition in the SQL WHERE clause.
|
inline const TTime &StartTime() const;
Gets the UTC start time used by the filter.
|
inline void SetStartTime(const TTime &aStartTime);
Sets the specified UTC start time to be used by the filter.
|
inline const TTime &EndTime() const;
Gets the UTC end time used by the filter.
|
inline void SetEndTime(const TTime &aEndTime);
Sets the specified UTC end time to be used by the filter.
|
IMPORT_C void Copy(const CLogFilter &aFilter);
Makes a copy of a filter.
|