Collapse all Symbian^3 Product Developer Library

CLogEventType Class Reference

class CLogEventType : public CBase

Encapsulates the details of an event type.

An event type is used to associate an event with a user-readable description and other configuration information related to the event.

Event types are identified by UID.

CLogEvent::EventType() CLogEvent::SetEventType()

Inherits from

CLogEventType
- CBase

Public Member Functions
	~CLogEventType()
IMPORT_C void	Copy(const CLogEventType &)
const TDesC &	Description()
void	ExternalizeL(RWriteStream &)
void	InternalizeL(RReadStream &)
TBool	LoggingEnabled()
IMPORT_C CLogEventType *	NewL()
void	SetDescription(const TDesC &)
void	SetLoggingEnabled(TBool)
void	SetUid(TUid)
TUid	Uid()

Private Member Functions
	CLogEventType()
void	ConstructL()
void	InternalizeBufL(RReadStream &, HBufC *&)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Private Attributes
HBufC *	iDescription
TBool	iLoggingEnabled
TUid	iUid

Constructor & Destructor Documentation

CLogEventType()

CLogEventType

(

)

[private]

~CLogEventType()

IMPORT_C

~CLogEventType

(

)

Frees all resources owned by the event type detail object.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

Copy(const CLogEventType &)

IMPORT_C void

Copy

(

const CLogEventType &

aType

)

Makes a copy of the specified event type.

Parameters

const CLogEventType & aType

The event type to be copied.

Description()

const TDesC &

Description

(

)

const [inline]

Gets the human readable and localised name of the event type.

ExternalizeL(RWriteStream &)

void

ExternalizeL

(

RWriteStream &

aStream

)

const

Parameters

RWriteStream & aStream

InternalizeBufL(RReadStream &, HBufC *&)

void	InternalizeBufL	(	RReadStream &	aStream,
			HBufC *&	aDes
		)	[private]

Parameters

RReadStream & aStream
HBufC *& aDes

InternalizeL(RReadStream &)

void

InternalizeL

(

RReadStream &

aStream

)

Parameters

RReadStream & aStream

LoggingEnabled()

TBool

LoggingEnabled

(

)

const [inline]

Determines whether logging for this event type is enabled.

NewL()

IMPORT_C CLogEventType *

NewL

(

)

[static]

Creates a new event type detail object.

SetDescription(const TDesC &)

void

SetDescription

(

const TDesC &

aDescription

)

[inline]

Sets the human readable and localised name of the event type.

For example, Email.

Parameters

const TDesC & aDescription

The name.

SetLoggingEnabled(TBool)

void

SetLoggingEnabled

(

TBool

aEnable

)

[inline]

Enables or disables logging for this event type.

Note that disabling the logging of an event type causes a CLogClient::AddEventL() request for an event of that type to complete with an appropriate error.

CLogClient::AddEvent()

Parameters

TBool aEnable

ETrue, to enable logging for this event type.EFalse, to disable logging for this event type.

SetUid(TUid)

void

SetUid

(

TUid

aUid

)

[inline]

Sets the UID identifying the event type.

Parameters

TUid aUid

The Uid.

Uid()

TUid

Uid

(

)

const [inline]

Gets the UID identifying the event type.

Member Data Documentation

HBufC * iDescription

HBufC *

iDescription

[private]

TBool iLoggingEnabled

TBool

iLoggingEnabled

[private]

TUid iUid

TUid

iUid

[private]