Class CLogView

class CLogView : public CLogActive;

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

• CBase - Base class for all classes to be instantiated on the heap

• CActive - The core class of the active object abstraction

• CLogActive - Common active object behaviour

• CLogView - Navigates a view on the log database

Members

Defined in CLogView:
CountL(), DoCancel(), DoRunL(), Event(), FirstL(), IsValid(), LastL(), NextL(), PreviousL(), SetFlagsL(), iClient, iData, iMaintain, iPackage, iSpare2, iValid, iViewId, iWindow, ~CLogView()

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

Inherited from CBase:
Delete(), operator new()

Inherited from CLogActive:
Complete(), DoComplete(), Queue(), RunL()

IMPORT_C ~CLogView();

Description

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

inline const CLogEvent &Event() const;

Description

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

Return value

const 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.

IMPORT_C 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 ETrue, if the function has successfully issued the asynchronous request. EFalse, if there are no events in the view.

IMPORT_C 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 ETrue, if the function has successfully issued the asynchronous request. EFalse, if there are no events in the view.

IMPORT_C 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 ETrue, if the function has successfully issued the asynchronous request. EFalse, if there are no events in the view.

IMPORT_C 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 ETrue, if the function has successfully issued the asynchronous request. EFalse, if there are no events in the view.

IMPORT_C TInt CountL();

Description

Gets the number of events in the view.

Return value

TInt The number of events in the view.

Capability:

Security policy note:

For built-in event types, the required capability level is defined in the event type's write access policy.

IMPORT_C void SetFlagsL(TLogFlags aFlags);

Description

Parameters

TLogFlags aFlags

protected: inline TBool IsValid() const;

Description

Return value

TBool

protected: virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().

private: virtual void DoRunL();

Description

protected: CLogClient & iClient;

Description

protected: CLogPackage * iPackage;

Description

protected: TAny * iSpare2;

Description

protected: CLogMaintainClientOp * iMaintain;

Description

protected: TLogViewId iViewId;

Description

protected: TDes8 * iData;

Description

protected: TBool iValid;

Description

protected: CLogViewWindow * iWindow;

Description