Class CLogView

CLogView

Support

Supported from 6.0

Description

Navigates a view on the log database.

The class provides functions for navigating through a set of events and a function to retrieve the event at the current position within the view.

The class cannot be instantiated. Further classes are derived from this class to define and construct views on the log database.

The set of events in a view are always ordered so that the first event in a view is the most recent.

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

Defined in CLogView:
CountL(), Event(), FirstL(), LastL(), NextL(), PreviousL(), ~CLogView()

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()

~CLogView();

Description

Frees all resources owned by this object prior to its destruction. In particular, any outstanding asynchronous request is cancelled.

const CLogEvent& Event() const;

Description

Returns details of the log event at the current position within the view.

Return value

CLogEvent& A reference to the log event details object. If a view does not contain any events, then the content of this object is undefined.

TBool FirstL(TRequestStatus& aStatus);

Description

Moves the current position in the view to the first event. The first event is the most recent event.

This is an asynchronous request.

Parameters

TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the position in the view has been successfully moved; 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 LastL(TRequestStatus& aStatus);

Description

Moves the current position in the view to the last event. The last event is the oldest event.

This is an asynchronous request.

Parameters

TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the position in the view has been successfully moved; 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 NextL(TRequestStatus& aStatus);

Description

Moves the current position in the view to the next event. The next event is always older than the current event, i.e. next implies movement in the first to last direction.

Parameters

TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the position in the view has been successfully moved; 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 PreviousL(TRequestStatus& aStatus);

Description

Moves the current position in the view to the previous event. The previous event is always more recent than the current event, i.e. previous implies movement in the last to first direction.

Parameters

TRequestStatus& aStatus The request status. On request completion, contains:KErrNone, if the position in the view has been successfully moved; 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.

TInt CountL();

Description

Gets the number of events in the view.

Return value

TInt The number of events in the view.