Interface access: | publishedPartner | |
class CCrashDataSave : public CBase;
Description
Class that defines the ECOM interface of a Core Dump Writer ECOM plugin. The responsibility of a writer plugin is to be a repository or channel for a formatter's crash data. The class is intended for derivation by implementations of the interface.
Derivation
CBase
- No description.CCrashDataSave
- Class that defines the ECOM interface of a Core Dump Writer ECOM plugin. The res...
Members
Defined in CCrashDataSave
More...
Close()
End the data save operation. CloseL()
End the data save operation. ECoreFilePath
This parameter is a root identifier for core dumps. Its use depends on the write...EDataSaveLastParam
GetConfigParameterL(const TInt)
Return the configuration parameter with ordinal aIndex. GetDescription(TDes &)
Obtain a description of the plugin.GetNumberConfigParametersL()
Return the number of configuration parameters implemented by the plugin.ListAllImplementationsL(RImplInfoPtrArray &)
NewL()
NewL(const TDesC8 &)
NewL(const TUid &)
Open(const TDesC &)
Used to start the saving of data. OpenL(const TDesC &)
Used to start the saving of data. RConfigParameterList
Define the container for the plugin's configuration parameters SetConfigParameterL(const TInt,const TInt32 &,const TDesC &)
Change the configuration parameter with ordinal aIndex to the given values. The ...TDataSaveParams
Writer plugin base configuration parameter identifiers. Identifiers for derived ...TExampleInterfaceInitParams
Interface for passing initialisation parameters to the derived class constructor...Write(TAny *,TUint)
Save data from a pointer given the data size. Write(TInt,TAny *,TUint)
Save aData at the specific position. Write(TInt,const TDesC8 &)
Save aData at the specific position. Write(const TDesC8 &)
Save data. WriteL(TAny *,TUint)
Save data from a pointer given the data size. WriteL(TInt,TAny *,TUint)
Save aData at the specific position. WriteL(TInt,const TDesC8 &)
Save aData at the specific position. WriteL(const TDesC8 &)
Save data. iConfigList
List of COptionConfig configuration parameters implemented by the plugin.iDtor_ID_Key
iSpare1
iSpare2
~CCrashDataSave()
Construction and destruction
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
static inline CCrashDataSave* NewL();
Description
Return value
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
static inline CCrashDataSave* NewL(const TDesC8 &aCue);
Description
Parameters
Return value
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
static inline CCrashDataSave* NewL(const TUid &aUid);
Description
Parameters
Return value
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
inline virtual ~CCrashDataSave();
Description
ListAllImplementationsL(RImplInfoPtrArray &)
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
static inline void ListAllImplementationsL(RImplInfoPtrArray &aImplInfoArray);
Description
Parameters
RImplInfoPtrArray &aImplInfoArray |
|
|
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual void GetDescription(TDes &aPluginDescription)=0;
Description
Obtain a description of the plugin.
Parameters
GetNumberConfigParametersL()
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual TInt GetNumberConfigParametersL()=0;
Description
Return the number of configuration parameters implemented by the plugin.
Return value
GetConfigParameterL(const TInt)
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual COptionConfig* GetConfigParameterL(const TInt aIndex)=0;
Description
Return the configuration parameter with ordinal aIndex.
Parameters
const TInt aIndex |
Parameter ordinal |
|
Return value
SetConfigParameterL(const TInt,const TInt32 &,const TDesC &)
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual void SetConfigParameterL(const TInt aIndex, const TInt32 &aValue, const TDesC &aDescValue)=0;
Description
Change the configuration parameter with ordinal aIndex to the given values. The plugin interprets and validates the values. Depending on the type of parameter, the plugin may use the integer parameter aValue or the descriptor parameter aDescValue
Parameters
const TInt aIndex |
Parameter ordinal |
const TInt32 &aValue |
Integer value |
const TDesC &aDescValue |
Descriptor value |
|
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual void OpenL(const TDesC &aParam)=0;
Description
Used to start the saving of data.
Parameters
const TDesC &aParam |
The interpretation of aParam is specific to the plugin. |
|
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual TInt Open(const TDesC &aParam)=0;
Description
Used to start the saving of data.
Parameters
const TDesC &aParam |
The interpretation of aParam is specific to the plugin. |
|
Return value
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual void CloseL()=0;
Pre-Condition
Must have called Open or OpenL
Description
End the data save operation.
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual TInt Close()=0;
Pre-Condition
Must have called Open or OpenL
Description
End the data save operation.
Return value
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual void WriteL(const TDesC8 &aData)=0;
Pre-Condition
Must have called Open or OpenL
Description
Save data.
Parameters
const TDesC8 &aData |
TDesC8 with data to be saved. |
|
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual TInt Write(const TDesC8 &aData)=0;
Pre-Condition
Must have called Open or OpenL
Description
Save data.
Parameters
const TDesC8 &aData |
TDesC8 with data to be saved. |
|
Return value
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual void WriteL(TAny *aData, TUint aSize)=0;
Pre-Condition
Must have called Open or OpenL
Description
Save data from a pointer given the data size.
Parameters
TAny *aData |
Pointer to data to be saved. |
TUint aSize |
Length of data to be saved in bytes |
|
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual TInt Write(TAny *aData, TUint aSize)=0;
Pre-Condition
Must have called Open or OpenL
Description
Save data from a pointer given the data size.
Parameters
TAny *aData |
Pointer to data to be saved. |
TUint aSize |
Length of data to be saved in bytes |
|
Return value
WriteL(TInt,const TDesC8 &)
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual void WriteL(TInt aPos, const TDesC8 &aData)=0;
Pre-Condition
Must have called Open or OpenL
Description
Save aData at the specific position.
Parameters
TInt aPos |
The interpretation of aPos is specific to the plugin. |
const TDesC8 &aData |
TDesC8 with data to be saved. |
|
Write(TInt,const TDesC8 &)
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual TInt Write(TInt aPos, const TDesC8 &aData)=0;
Pre-Condition
Must have called Open or OpenL
Description
Save aData at the specific position.
Parameters
TInt aPos |
The interpretation of aPos is specific to the plugin. |
const TDesC8 &aData |
TDesC8 with data to be saved. |
|
Return value
WriteL(TInt,TAny *,TUint)
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual void WriteL(TInt aPos, TAny *aData, TUint aSize)=0;
Pre-Condition
Must have called Open or OpenL
Description
Save aData at the specific position.
Parameters
TInt aPos |
The interpretation of aPos is specific to the plugin. |
TAny *aData |
Pointer to data to be saved. |
TUint aSize |
Length of data to be saved in bytes |
|
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
virtual TInt Write(TInt aPos, TAny *aData, TUint aSize)=0;
Pre-Condition
Must have called Open or OpenL
Description
Save aData at the specific position.
Parameters
TInt aPos |
The interpretation of aPos is specific to the plugin. |
TAny *aData |
Pointer to data to be saved. |
TUint aSize |
Length of data to be saved in bytes |
|
Return value
Struct TExampleInterfaceInitParams
Interface access: | publishedPartner | |
struct TExampleInterfaceInitParams;
Description
Interface for passing initialisation parameters to the derived class constructor. Standard ECOM implementation.
Members
Defined in CCrashDataSave::TExampleInterfaceInitParams
:
Member data
integer
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
TInt integer;
Description
Integer cue
descriptor
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
const TDesC * descriptor;
Description
Descriptor cue
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
TDataSaveParams
Description
Writer plugin base configuration parameter identifiers. Identifiers for derived interfaces should start where this enum ends.
ECoreFilePath |
This parameter is a root identifier for core dumps. Its use depends on the writer plugin and potentially the formatters. For example for an email data save plugin this parameter could be an the email address. For a file writer it could be a file name or a directory path. |
EDataSaveLastParam |
|
|
Typedef RConfigParameterList
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
protected: typedef RPointerArray<COptionConfig> CCrashDataSave::RConfigParameterList;
Description
Define the container for the plugin's configuration parameters
Interface access: | publishedPartner | Inherited from: crashdatasave.h |
protected: RConfigParameterList iConfigList;
Description
List of COptionConfig
configuration parameters implemented by the plugin.
Interface access: | internal to technology | Default as private. |
private: TUid iDtor_ID_Key;
Description
Interface access: | internal to technology | Default as private. |
private: TUint32 iSpare1;
Description
Interface access: | internal to technology | Default as private. |
private: TUint32 iSpare2;
Description