Symbian
Symbian OS Library

SYMBIAN OS V9.2

[Index] [Spacer] [Previous] [Next]



Location: LOGCLI.H
Link against: logcli.lib

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

Members

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

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:


Construction and destruction


NewL()

static IMPORT_C CLogEventType *NewL();

Description

Creates a new event type detail object.

Return value

CLogEventType *

Pointer to the new event type detail object.


~CLogEventType()

IMPORT_C ~CLogEventType();

Description

Frees all resources owned by the event type detail object.

[Top]


Member functions


Uid()

inline TUid Uid() const;

Description

Gets the UID identifying the event type.

Return value

TUid

The UID.


SetUid()

inline void SetUid(TUid aUid);

Description

Sets the UID identifying the event type.

Parameters

TUid aUid

The Uid.


Description()

inline const TDesC &Description() const;

Description

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

Return value

const TDesC &

A non-modifiable descriptor containing the name.


SetDescription()

inline 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.


LoggingEnabled()

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.


SetLoggingEnabled()

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

See also:


Copy()

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.