CLogBase Class Reference

#include <logwrap.h>

Link against: logstub.lib

class CLogBase : public CLogActive

Inherits from

CLogBase
- CLogActive
  - CActive
    - CBase

Public Member Functions
	CLogBase(TInt)
	~CLogBase()
virtual IMPORT_C void	AddEvent(CLogEvent &, TRequestStatus &)
virtual IMPORT_C void	ChangeEvent(const CLogEvent &, TRequestStatus &)
virtual IMPORT_C void	DeleteEvent(TLogId, TRequestStatus &)
virtual IMPORT_C void	GetEvent(CLogEvent &, TRequestStatus &)
virtual IMPORT_C TInt	GetString(TDes &, TInt)

Protected Member Functions
IMPORT_C void	LoadResourcesL(RFs &)
const CResourceFile *	ResourceFile()

Inherited Attributes
	CActive::iStatus

Inherited Enumerations
	CActive:TPriority

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CLogActive::CLogActive(TInt)
	CLogActive::Complete(TInt)
	CLogActive::DoCancel()
	CLogActive::Queue(TRequestStatus &)
	CLogActive::~CLogActive()

Detailed Description

Base class for the log engine implementation.

This class defines the interface that client code uses to perform simple actions on the log database.

The class provides default implementations for the event handling functions. The Log Engine, i.e. an instance of CLogClient, is derived from this class and provides implementations for the event handling functions.

The class also deals with some aspects of resource file handling.

An instance of this class is constructed by the log wrapper, CLogWrapper, if the phone does not implement logging.

An instance of this class is never constructed by clients.

See also: CLogClient CLogWrapper

Constructor & Destructor Documentation

CLogBase ( TInt )

IMPORT_C

CLogBase

(

aPriority

)

Sets the priority of this active object.

Parameters
aPriority	The priority of this active object.

~CLogBase ( )

IMPORT_C

~CLogBase

(

)

Fees all resources owned by the object prior to its destruction. In particular it closes the resource file reader.

Member Function Documentation

AddEvent ( CLogEvent &, TRequestStatus & )

IMPORT_C void	AddEvent	(	CLogEvent &	aEvent,
			TRequestStatus &	aStatus
		)	[virtual]

Adds an event to the log database. This is an asynchronous request.

This function is overridden by log engine implementations.

Parameters
aEvent	A reference to a log event detail object. This value is not used.
aStatus	The request status. On completion of the asynchronous request, it always contains KErrNotSupported.

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

ChangeEvent ( const CLogEvent &, TRequestStatus & )

IMPORT_C void	ChangeEvent	(	const CLogEvent &	aEvent,
			TRequestStatus &	aStatus
		)	[virtual]

Changes the details of an existing event. This is an asynchronous request.

This function is overridden by log engine implementations.

Parameters
aEvent	A reference to a log event detail object. This value is not used.
aStatus	The request status. On completion of the asynchronous request, it always contains KErrNotSupported.

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

DeleteEvent ( TLogId, TRequestStatus & )

IMPORT_C void	DeleteEvent	(	TLogId	aId,
			TRequestStatus &	aStatus
		)	[virtual]

Deletes an event from the log. This is an asynchronous request.

This function is overridden by log engine implementations.

Parameters
aId	The unique event ID of the event to be deleted. This value is not used.
aStatus	The request status. On completion of the asynchronous request, it always contains KErrNotSupported..

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

GetEvent ( CLogEvent &, TRequestStatus & )

IMPORT_C void	GetEvent	(	CLogEvent &	aEvent,
			TRequestStatus &	aStatus
		)	[virtual]

Gets the details of an existing event. This is an asynchronous request.

This function is overridden by log engine implementations.

Parameters
aEvent	A reference to a log event detail object. This value is not used.
aStatus	The request status. On completion of the asynchronous request, it always contains KErrNotSupported.

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

GetString ( TDes &, TInt )

IMPORT_C TInt	GetString	(	TDes &	aString,
			TInt	aId
		)	const [virtual]

Gets a standard string from the logwrap.dll resource file.

This function is overridden by log engine implementations.

See also: RResourceFile

Parameters
aString	A modifiable descriptor. The length of this descriptor is set to zero.
aId	The resource ID for the string. This value is not used.

Return Value: KErrNotSupported.

LoadResourcesL ( RFs & )

IMPORT_C void

LoadResourcesL

(

RFs &

aFs

)

[protected]

ResourceFile ( )

const CResourceFile *

ResourceFile

(

)

const [protected, inline]