Class CLogWrapper

class CLogWrapper : public CBase;

Description

The log wrapper.

As some UI variants do not use a Log Engine, the log wrapper provides a consistent interface to clients that need to work, without being changed, with multiple UI variants.

The log wrapper is provided in its own DLL, the logwrap.dll.

If a Log Engine is not installed on a phone, the log wrapper creates an instance of the CLogBase class, whose event handling requests complete with KErrNotSupported and whose functions return KErrNotSupported.

If a Log Engine is installed on a phone, the log wrapper creates an instance of the CLogClient class, provided in a separate DLL, the logcli.dll . The CLogClient class derives from CLogBase and provides implementations for the event handling requests and functions.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CLogWrapper - The log wrapper.

Members

Defined in CLogWrapper:

• ClientAvailable()constDetermines whether the Log Engine is installed.
• Log()Gets a reference to the Log Engine object.
• NewL(RFs &,TInt)
• ~CLogWrapper()Frees all resources owned by the log wrapper prior to its destruction. Specifica...

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:

• CLogBaseBase class for the log engine implementation.
• CLogClientLog Engine implementation.

IMPORT_C static CLogWrapper* NewL(RFs &aFs, TInt aPriority=CActive::EPriorityStandard);

Description

Parameters

RFs &aFs TInt aPriority

Return value

CLogWrapper *

IMPORT_C ~CLogWrapper();

Description

Frees all resources owned by the log wrapper prior to its destruction. Specifically, it deletes the Log Engine (or the instance of the Log Engine base class, if the UI variant does not have a Log Engine installed).

inline CLogBase& Log();

Description

Gets a reference to the Log Engine object.

Return value

CLogBase & If the Log Engine is installed, this is a reference to a CLogClient object. If there is no Log Engine, this is a reference to an instance of the Log Engine base class, CLogBase.

See also:

• CLogClientLog Engine implementation.

IMPORT_C TBool ClientAvailable() const;

Description

Determines whether the Log Engine is installed.

Return value

TBool ETrue if there is a Log Engine, EFalse, otherwise.