CLogEventType Class Reference

#include <logcli.h>

Link against: logcli.lib

class CLogEventType : public CBase

Inherits from

  • CLogEventType
    Public Member Functions
    ~CLogEventType()
    IMPORT_C voidCopy(const CLogEventType &)
    const TDesC &Description()
    voidExternalizeL(RWriteStream &)
    voidInternalizeL(RReadStream &)
    TBool LoggingEnabled()
    IMPORT_C CLogEventType *NewL()
    voidSetDescription(const TDesC &)
    voidSetLoggingEnabled(TBool)
    voidSetUid(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.

    See also: CLogEvent::EventType() CLogEvent::SetEventType()

    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 voidCopy(const CLogEventType &aType)

    Makes a copy of the specified event type.

    ParameterDescription
    aTypeThe event type to be copied.

    Description ( )

    const TDesC &Description()const [inline]

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

    Returns: A non-modifiable descriptor containing the name.

    ExternalizeL ( RWriteStream & )

    voidExternalizeL(RWriteStream &aStream)const

    InternalizeL ( RReadStream & )

    voidInternalizeL(RReadStream &aStream)

    LoggingEnabled ( )

    TBool LoggingEnabled()const [inline]

    Determines whether logging for this event type is enabled.

    Returns: ETrue, if logging is enabled. EFalse, if logging is disabled.

    NewL ( )

    IMPORT_C CLogEventType *NewL()[static]

    Creates a new event type detail object.

    Returns: Pointer to the new event type detail object.

    SetDescription ( const TDesC & )

    voidSetDescription(const TDesC &aDescription)[inline]

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

    For example, Email.

    ParameterDescription
    aDescriptionThe name.

    SetLoggingEnabled ( TBool )

    voidSetLoggingEnabled(TBoolaEnable)[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.

    See also: CLogClient::AddEvent()

    ParameterDescription
    aEnableETrue, to enable logging for this event type.EFalse, to disable logging for this event type.

    SetUid ( TUid )

    voidSetUid(TUidaUid)[inline]

    Sets the UID identifying the event type.

    ParameterDescription
    aUidThe Uid.

    Uid ( )

    TUid Uid()const [inline]

    Gets the UID identifying the event type.

    Returns: The UID.

    © Nokia 2011.