![[Index]](../../../../a_stock/btn_index_wt.gif){kind=small}
![[Spacer]](../../../../a_stock/btn_spacer.gif){kind=small}
![[Previous]](../../../../a_stock/btn_prev_wt.gif){kind=small}
![[Next]](../../../../a_stock/btn_next_wt.gif){kind=small}
|
|
|
|
|
|
||
Location:
LOGCLI.H
Link against: logcli.lib
class CLogClient : public CLogBase;
Log Engine implementation.
It creates a shared session on the log database and allows log viewers to retrieve events from the log.
The class also provides log administration functions.
Wherever time values are used by this class, they must be specified as UTC rather than local time.
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
CLogBase - Base class for the log engine implementation
CLogClient - Log Engine implementation
Defined in CLogClient:
AddEvent(), AddEventType(), CLogBase_Reserved1(), ChangeConfig(), ChangeEvent(), ChangeEventType(), ClearLog(), ClearLog(), DeleteEvent(), DeleteEventType(), DoCancel(), DoRunL(), GetConfig(), GetEvent(), GetEventType(), GetString(), NewL(), NotifyChange(), NotifyChangeCancel(), SetGlobalChangeObserverL(), ~CLogClient()
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()
Inherited from CLogBase:
LoadResourcesL(),
ResourceFile()
static IMPORT_C CLogClient *NewL(RFs &aFs, TInt aPriority=CActive::EPriorityStandard);
|
|
IMPORT_C ~CLogClient();
Frees all resources owned by the Log Engine object prior to its destruction. In particular, any outstanding asynchronous request is cancelled, the database, the database session and the resource file are all closed.
|
|
| Capability: | Security policy note: | For built-in event types, the required capability level is defined in the event type's write access policy. |
virtual IMPORT_C void AddEvent(CLogEvent &aEvent, TRequestStatus &aStatus);
Adds an event to the log database. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
|
| Capability: | Security policy note: | For built-in event types, the required capability level is defined in the event type's read access policy. |
virtual IMPORT_C void GetEvent(CLogEvent &aEvent, TRequestStatus &aStatus);
Gets the details of the specified event. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
|
| Capability: | Security policy note: | For built-in event types, the required capability level is defined in the event type's write access policy. |
virtual IMPORT_C void ChangeEvent(const CLogEvent &aEvent, TRequestStatus &aStatus);
Changes the details of an existing event. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
Note that it is not possible to change the event type using this function.
|
| Capability: | Security policy note: | For built-in event types, the required capability level is defined in the event type's write access policy. |
virtual IMPORT_C void DeleteEvent(TLogId aId, TRequestStatus &aStatus);
Deletes the event with the specified unique event ID, from the main event log.
|
| Capability: | WriteDeviceData |
IMPORT_C void AddEventType(const CLogEventType &aType, TRequestStatus &aStatus);
Registers a new event type. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
|
| Capability: | Security policy note: | None required. |
IMPORT_C void GetEventType(CLogEventType &aType, TRequestStatus &aStatus);
Gets the details of an event type. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
|
| Capability: | WriteDeviceData |
IMPORT_C void ChangeEventType(const CLogEventType &aType, TRequestStatus &aStatus);
Changes the details of an existing event type. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
|
| Capability: | WriteDeviceData |
IMPORT_C void DeleteEventType(TUid aId, TRequestStatus &aStatus);
Removes an existing event type. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
Note that this function does not remove events from the event log, so it is possible to have events in the log that are of an unknown type. This function allows an event type associated with a component to be removed when that component is uninstalled.
|
| Capability: | Security policy note: | None required. |
IMPORT_C void GetConfig(TLogConfig &aConfig, TRequestStatus &aStatus);
Gets the Log Engine configuration. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
|
| Capability: | WriteDeviceData |
IMPORT_C void ChangeConfig(const TLogConfig &aConfig, TRequestStatus &aStatus);
Changes the Log Engine configuration. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
|
| Capability: | WriteDeviceData |
IMPORT_C void ClearLog(const TTime &aDate, TRequestStatus &aStatus);
Clears all events from the main event log that occurred before the specified date and time. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
|
| Capability: | WriteDeviceData |
IMPORT_C void ClearLog(TInt aRecentList, TRequestStatus &aStatus);
Clears the specified recent event list. This is an asynchronous request.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
|
| Capability: | Security policy note: | None required. |
IMPORT_C void NotifyChange(TTimeIntervalMicroSeconds32 aDelay, TRequestStatus &aStatus);
Requests notification of changes to the Log Engine database. This is an asynchronous request.
The function requires the caller to specify a minimum time that must elapse before this notification request can complete. The Log Engine buffers all changes that occur during this time; the request, then completes after this minimum time period has elapsed. If no changes occur within this time period, then the request completes when the next change to the database occurs.
There must be no asynchronous request outstanding when this function is called, otherwise the function raises a LogCli 0 panic.
Note that once a notification request has completed, this function must be called again to get further change notifications.
|
| Capability: | Security policy note: | None required |
IMPORT_C void NotifyChangeCancel();
Cancels any outstanding notification request for changes to Log Engine database.
This function can be called even if there is no outstanding notification request.
| Capability: | Security policy note: | None required |
IMPORT_C void SetGlobalChangeObserverL(MLogClientChangeObserver *aObserver);
|
| Capability: | Security policy note: | None required. |
virtual IMPORT_C TInt GetString(TDes &aString, TInt aId) const;
Gets a standard string from the specified resource in logwrap.dll resource file.
The function can be used to populate some of the event fields in a CLogEvent object before creating or changing an event.
Note that TLogString is a modifiable buffer descriptor that is guaranteed to be large enough to contain all standard strings used in the Log Engine; pass an instance of this type to this function.
|
|
private: virtual void DoCancel();
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 IMPORT_C void CLogBase_Reserved1();
|
Copyright ©2008 Symbian Software Ltd. |
|
![[Top]](../../../../a_stock/arrow_up_2.gif){kind=icon}
![[Previous]](../../../../a_stock/btn_prev.gif){kind=small}
![[Top]](../../../../a_stock/btn_top.gif)
![[Next]](../../../../a_stock/btn_next.gif){kind=small}