#include <formatterapi.h>

Class CCoreDumpFormatter

Interface access: publishedPartner

class CCoreDumpFormatter : public CBase;

Description

Definition of the ECOM Core Dump Formatting interface. The interface is pure virtual. Formatters must implement this interface for the core dump server to be able to load them.

Derivation

    • CBase - No description.
      • CCoreDumpFormatter - Definition of the ECOM Core Dump Formatting interface. The interface is pure vir...

Members

Defined in CCoreDumpFormatter:

Construction and destruction


NewL()

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

static inline CCoreDumpFormatter* NewL();

Description

Return value

CCoreDumpFormatter *


NewL(const TDesC8 &)

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

static inline CCoreDumpFormatter* NewL(const TDesC8 &aCue);

Description

Parameters

const TDesC8 &aCue

Return value

CCoreDumpFormatter *


NewL(const TUid &)

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

static inline CCoreDumpFormatter* NewL(const TUid &aUid);

Description

Parameters

const TUid &aUid

Return value

CCoreDumpFormatter *


~CCoreDumpFormatter()

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

inline virtual ~CCoreDumpFormatter();

Description


CCoreDumpFormatter()

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

protected: inline CCoreDumpFormatter();

Description

Member functions


ListAllImplementationsL(RImplInfoPtrArray &)

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

static inline void ListAllImplementationsL(RImplInfoPtrArray &aImplInfoArray);

Description

Parameters

RImplInfoPtrArray &aImplInfoArray


ConfigureDataSaveL(CCrashDataSave *)

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

virtual void ConfigureDataSaveL(CCrashDataSave *aDataSave)=0;

Description

Core dump server makes this call to supply the formatter with the data save object. The formatter can then use this object to store its crash data. The formatter does not own the object.

Parameters

CCrashDataSave *aDataSave

Data save object to save crash data to.

See also:

  • CCrashDataSaveClass that defines the ECOM interface of a Core Dump Writer ECOM plugin. The res...

ConfigureDataSourceL(CCrashDataSource *)

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

virtual void ConfigureDataSourceL(CCrashDataSource *aDataSource)=0;

Description

Core dump server makes this call to supply the formatter with the data source object. The formatter can then use this object to obtain crash data. The formatter does not own the object.

Parameters

CCrashDataSource *aDataSource

Data source object to obtain crash data from.

See also:

  • CCrashDataSourceDefinition of the Data Source API. This API is used by formatters to obtain cras...

GetDescription(TDes &)

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

virtual void GetDescription(TDes &aPluginDescription)=0;

Description

Call used to obtain a text description of the formatter. Can be used by UIs to present a description to the user.

Parameters

TDes &aPluginDescription

Descriptor with formatter descriptor.


CrashEventL(TCrashInfo *)

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

virtual void CrashEventL(TCrashInfo *aCrashInfo)=0;

Description

This method informs the formatter that a crash event has occured. Called by Core Dump Server, which owns the TCrashInfo object.

Parameters

TCrashInfo *aCrashInfo

Crash event information with crash data. Object is owned by caller.

See also:

  • TCrashInfoCrash event information. This is given to a formatter when a crash occurs.

GetNumberConfigParametersL()

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

virtual TInt GetNumberConfigParametersL()=0;

Description

Used to obtain the number of configuration parameters implemented by the formatter. Use this call in conjunction with CCoreDumpFormatter::GetConfigParameterL(const TInt).

Return value

TInt

Number of configuration parameters implemented by formatter.

See also:

  • COptionConfigClass that represents a configuration parameter. It is based on CStreamElementBa...

GetConfigParameterL(const TInt)

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

virtual COptionConfig* GetConfigParameterL(const TInt aIndex)=0;

Description

Return the configuration parameter indexed by aIndex. aIndex should be less than the value returned by CCoreDumpFormatter::GetNumberConfigParametersL().

Parameters

const TInt aIndex

Parameter ordinal to retrieve.

Return value

COptionConfig *

Pointer to a COptionConfig object that is then owned by the caller.

See also:


SetConfigParameterL(const TInt,const TInt32 &,const TDesC &)

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

virtual void SetConfigParameterL(const TInt aIndex, const TInt32 &aValue, const TDesC &aDescValue)=0;

Description

Set the value of a configuration parameters indexed by aIndex.

Parameters

const TInt aIndex

Parameter ordinal to change.

const TInt32 &aValue

Integer value.

const TDesC &aDescValue

Descriptor value.

See also:

  • COptionConfigClass that represents a configuration parameter. It is based on CStreamElementBa...

Member structures


Struct TExampleInterfaceInitParams

Interface access: publishedPartnerInherited from: CCoreDumpFormatter

struct TExampleInterfaceInitParams;

Description

Interface for passing initialisation parameters to the derived class constructor. Standard ECOM implementation.

Members

Defined in CCoreDumpFormatter::TExampleInterfaceInitParams:

Member data


integer

Interface access: publishedPartnerInherited from: CCoreDumpFormatter, Inherited from: CCoreDumpFormatter

TInt integer;

Description

Integer cue


descriptor

Interface access: publishedPartnerInherited from: CCoreDumpFormatter, Inherited from: CCoreDumpFormatter

const TDesC * descriptor;

Description

Descriptor cue

Member data


iDtor_ID_Key

Interface access: internal to technologyDefault as private.

private: TUid iDtor_ID_Key;

Description


iSpare1

Interface access: internal to technologyDefault as private.

private: TUint32 iSpare1;

Description


iSpare2

Interface access: internal to technologyDefault as private.

private: TUint32 iSpare2;

Description