Class CLogEventType

class CLogEventType : public CBase;

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.

Members

Defined in CLogEventType:

• Copy(const CLogEventType &)Makes a copy of the specified event type.
• Description()constGets the human readable and localised name of the event type.
• LoggingEnabled()constDetermines whether logging for this event type is enabled.
• NewL()Creates a new event type detail object.
• SetDescription(const TDesC &)Sets the human readable and localised name of the event type.
• SetLoggingEnabled(TBool)Enables or disables logging for this event type.
• SetUid(TUid)Sets the UID identifying the event type.
• Uid()constGets the UID identifying the event type.
• ~CLogEventType()Frees all resources owned by the event type detail object.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

See also:

• CLogEvent::EventType()constGets the type of this log event. Event types are identified by a UID.
• CLogEvent::SetEventType(TUid)Sets the type of this log event. Event types are identified by a UID.

IMPORT_C static CLogEventType* NewL();

Description

Creates a new event type detail object.

Return value

CLogEventType * Pointer to the new event type detail object.

IMPORT_C ~CLogEventType();

Description

Frees all resources owned by the event type detail object.

inline TUid Uid() const;

Description

Gets the UID identifying the event type.

Return value

TUid The UID.

inline void SetUid(TUid aUid);

Description

Sets the UID identifying the event type.

Parameters

TUid aUid The Uid.

inline const TDesC& Description() const;

Description

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

Return value

const TDesC16 & A non-modifiable descriptor containing the name.

inline void SetDescription(const TDesC &aDescription);

Description

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

For example, Email.

Parameters

const TDesC16 &aDescription The name.

inline TBool LoggingEnabled() const;

Description

Determines whether logging for this event type is enabled.

Return value

TBool ETrue, if logging is enabled. EFalse, if logging is disabled.

inline 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 EFalse, to disable logging for this event type.

See also:

• CLogClient::AddEvent(CLogEvent &,TRequestStatus &)Adds an event to the log database. This is an asynchronous request.

IMPORT_C void Copy(const CLogEventType &aType);

Description

Makes a copy of the specified event type.

Parameters

const CLogEventType &aType The event type to be copied.