DoctorDumpSDK
Public Member Functions | List of all members
crash_rpt::custom_data_collection::IDataBag Struct Referenceabstract

This interface used to add custom data to crash report. More...

#include <CrashRpt.h>

Public Member Functions

virtual bool AddFileToReport (LPCWSTR path, LPCWSTR reportFileName)=0
 
virtual bool RemoveFileFromReport (LPCWSTR path)=0
 
virtual bool AddUserInfoToReport (LPCWSTR key, LPCWSTR value)=0
 
virtual bool RemoveUserInfoFromReport (LPCWSTR key)=0
 

Detailed Description

This interface used to add custom data to crash report.

Member Function Documentation

◆ AddFileToReport()

virtual bool crash_rpt::custom_data_collection::IDataBag::AddFileToReport ( LPCWSTR  path,
LPCWSTR  reportFileName 
)
pure virtual

You may add any file to crash report. This file will be read when crash appears and will be sent within the report. Multiple files may be added. Filename of the file in the report may be changed to any name.

Returns
If the function succeeds, the return value is true.
Parameters
[in]pathPath to the file, that will be added to the report.
[in]reportFileNameFilename that will be used in report for this file. If parameter is NULL, original name from path will be used.

◆ AddUserInfoToReport()

virtual bool crash_rpt::custom_data_collection::IDataBag::AddUserInfoToReport ( LPCWSTR  key,
LPCWSTR  value 
)
pure virtual

You may add any key/value pair to crash report.

Returns
If the function succeeds, the return value is true.
Parameters
[in]keykey string that will be added to the report.
[in]valuevalue for the key.

◆ RemoveFileFromReport()

virtual bool crash_rpt::custom_data_collection::IDataBag::RemoveFileFromReport ( LPCWSTR  path)
pure virtual

Remove from report the file that was registered earlier to be sent within report.

Returns
If the function succeeds, the return value is true.
Parameters
[in]pathPath to the file, that will be removed from the report.

◆ RemoveUserInfoFromReport()

virtual bool crash_rpt::custom_data_collection::IDataBag::RemoveUserInfoFromReport ( LPCWSTR  key)
pure virtual

You may remove any key that was added previously to crash report by crash_rpt::CrashRpt::AddUserInfoToReport.

Returns
If the function succeeds, the return value is true.
Parameters
[in]keykey string that will be removed from the report.