CLogEventType Class Reference

#include <logcli.h>

Link against: logcli.lib

class CLogEventType : public CBase

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

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

Detailed Description

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.

Constructor & Destructor Documentation

~CLogEventType ( )

IMPORT_C

~CLogEventType

(

)

Frees all resources owned by the event type detail object.

Member Function Documentation

Copy ( const CLogEventType & )

IMPORT_C void

Copy

(

const CLogEventType &

aType

)

Makes a copy of the specified event type.

Parameters
aType	The event type to be copied.

Description ( )

const TDesC &

Description

(

)

const [inline]

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

Return Value: A non-modifiable descriptor containing the name.

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aStream

)

const

InternalizeL ( RReadStream & )

void

InternalizeL

(

RReadStream &

aStream

)

LoggingEnabled ( )

TBool

LoggingEnabled

(

)

const [inline]

Determines whether logging for this event type is enabled.

Return Value: ETrue, if logging is enabled. EFalse, if logging is disabled.

NewL ( )

IMPORT_C CLogEventType *

NewL

(

)

[static]

Creates a new event type detail object.

Return Value: Pointer to the 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
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.

Parameters
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
aUid	The Uid.

Uid ( )

TUid

Uid

(

)

const [inline]

Gets the UID identifying the event type.

Return Value: The UID.