Class CLogViewRecent

CLogViewRecent

Support

Supported from 6.0

Description

A view on a recent event list.

Derivation

CActive The core class of the active object abstraction CBase Base class for all classes to be instantiated on the heap CLogActive Common active object behaviour CLogView Navigates a view on the log database CLogViewRecent A view on a recent event list

Defined in CLogViewRecent:
DuplicatesL(), NewL(), RecentList(), RemoveL(), SetRecentListL(), ~CLogViewRecent()

Inherited from CActive:
Cancel(), Deque(), DoCancel(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, IsActive(), IsAdded(), Priority(), RunError(), RunL(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
operator new()

Inherited from CLogView:
CountL(), Event(), FirstL(), LastL(), NextL(), PreviousL()

static CLogViewRecent* NewL(CLogClient& aClient, TInt aPriority = CActive::EPriorityStandard);

Description

Creates a new view on a recent event list.

After construction, the view is empty.

Parameters

CLogClient& aClient The Log Engine. Gives access to the log database for which the view is constructed. TInt aPriority = CActive::EPriorityStandard The priority of this active object. By default, this is the standard active object priority.

Return value

CLogViewRecent* A pointer to the new recent event list view object.

~CLogViewRecent();

Description

Frees resources owned by the object priot to its destruction.

TBool SetRecentListL(TLogRecentList aList, TRequestStatus& aStatus);

Description

Initialises or refreshes the view for the specified recent event list. This is an asynchronous request.

On successful completion, the view is positioned at the first, i.e. most recent, event within the recent event list.

Parameters

TLogRecentList aList The recent event list specifier. A value of KLogNullRecentList indicates that the view is to include events from all of the recent event lists. TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the view has been successfully initialised or refreshed; otherwise, one of the other system wide error codes.

Return value

TBool True, if the function has successfully issued the asynchronous request. False, if there are no events in the view.

TBool SetRecentListL(TLogRecentList aList, const CLogFilter& aFilter, TRequestStatus& aStatus);

Description

Initialises or refreshes the view for the specified recent event list, conforming to the specified filter. This is an asynchronous request.

On successful completion, the view is positioned at the first, i.e. most recent, event in the recent event list.

Parameters

TLogRecentList aList The recent event list specifier. A value of KLogNullRecentList indicates that the view is to include events from all of the recent event lists. const CLogFilter& aFilter The filter. TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the view has been successfully initialised or refreshed; otherwise, one of the other system wide error codes.

Return value

TBool True, if the function has successfully issued the asynchronous request. False, if there are no events in the view.

TBool SetRecentListL(TLogRecentList aList, const CLogFilterList& aFilterList, TRequestStatus& aStatus);

Description

Initialises or refreshes the view for the specified recent event list, conforming to the set of specified filters. This is an asynchronous request.

On successful completion, the view is positioned at the first, i.e. most recent, event in the recent event list.

Parameters

TLogRecentList aList The recent event list specifier. A value of KLogNullRecentList indicates that the view is to include events from all of the recent event lists. const CLogFilterList& aFilterList The set of filters. TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the view has been successfully initialised or refreshed; otherwise, one of the other system wide error codes.

Return value

TBool True, if the function has successfully issued the asynchronous request. False, if there are no events in the view.

TLogRecentList RecentList() const;

Description

Gets the recent event list number that identifies the recent event list to which the current entry belongs. This is an asynchronous request.

Note that this function is only useful if KLogNullRecentList is passed to the SetRecentListL() functions.

Return value

TLogRecentList The recent event list number.

TBool DuplicatesL(CLogViewDuplicate& aView, TRequestStatus& aStatus);

Description

Refreshes the specified duplicate event view with the duplicates of the current event in the recent event list view. This is an asynchronous request.

On successful completion, the view is positioned at the first, i.e. most recent, event within the view.

Parameters

CLogViewDuplicate& aView The duplicates view to be refreshed. TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the view has been successfully refreshed; otherwise, one of the other system wide error codes.

Return value

TBool True, if the function has successfully issued the asynchronous request. False, if there are no events in the view.

TBool DuplicatesL(CLogViewDuplicate& aView, const CLogFilter& aFilter, TRequestStatus& aStatus);

Description

Refreshes the specified duplicate event view with the duplicates of the current event in the recent event list view and conforming to the specified filter. This is an asynchronous request.

On successful completion, the view is positioned at the first, i.e. most recent, event within the view.

Parameters

CLogViewDuplicate& aView The duplicates view to be refreshed. const CLogFilter& aFilter The filter. TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the view has been successfully refreshed; otherwise, one of the other system wide error codes.

Return value

TBool True, if the function has successfully issued the asynchronous request. False, if there are no events in the view.

TBool DuplicatesL(CLogViewDuplicate& aView, const CLogFilterList& aFilterList, TRequestStatus& aStatus);

Description

Refreshes the specified duplicate event view with the duplicates of the current event in the recent event list view and conforming to the set of specified filters. This is an asynchronous request.

On successful completion, the view is positioned at the first, i.e. most recent, event within the view.

Parameters

CLogViewDuplicate& aView The duplicates view to be refreshed. const CLogFilterList& aFilterList The set of filters. TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the view has been successfully refreshed; otherwise, one of the other system wide error codes.

Return value

TBool True, if the function has successfully issued the asynchronous request. False, if there are no events in the view.

void RemoveL(TLogId aId);

Description

Removes the event with the specified unique event ID from the view. This does not delete the event from the main event log.

Parameters

TLogId aId The unique event ID.

TBool RemoveL(TRequestStatus& aStatus);

Description

Removes the current event from its recent event list. This is an asynchronous request.

This does not delete the event from the main event log.

The function moves the current position in the view to the first, i.e. most recent, event.

Note that removing a recent event from a recent event list also removes all of its duplicates.

Parameters

TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the view has been successfully initialised or refreshed; otherwise, one of the other system wide error codes.

Return value

TBool True, if the function has successfully issued the asynchronous request. False, if there are no events in the view.