Class CLogEventType

CLogEventType

Support

Supported from 6.0

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.

Derivation

CBase Base class for all classes to be instantiated on the heap CLogEventType Encapsulates the details of an event type

Defined in CLogEventType:
Copy(), Description(), LoggingEnabled(), NewL(), SetDescription(), SetLoggingEnabled(), SetUid(), Uid(), ~CLogEventType()

Inherited from CBase:
operator new()

See also:

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

static CLogEventType* NewL();

Description

Creates a new event type detail object.

Return value

CLogEventType* Pointer to the new event type detail object.

~CLogEventType();

Description

Frees all resources owned by the event type detail object.

void SetDescription(const TDesC& aDescription);

Description

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

For example, Email.

Parameters

const TDesC& aDescription The name.

const TDesC& Description() const;

Description

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

Return value

TDesC& A non-modifiable descriptor containing the name.

void SetUid(TUid aUid);

Description

Sets the UID identifying the event type.

Parameters

TUid aUid The Uid.

See also:

• The log event types

TUid Uid() const;

Description

Gets the UID identifying the event type.

Return value

TUid The UID.

See also:

• The log event types

void SetLoggingEnabled(TBool aEnable);

Description

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

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

See also:

• CLogClient::AddEvent()

TBool LoggingEnabled() const;

Description

Determines whether logging for this event type is enabled.

Return value

TBool True, if logging is enabled. False, if logging is disabled.

void Copy(const CLogEventType& aType);

Description

Makes a copy of the specified event type.

Parameters

const CLogEventType& aType The event type to be copied.