To enable crash processing you should create an instance of this class. More...

#include <CrashRpt.h>

Public Member Functions
	CrashRpt (LPCSTR applicationGUID, LPCWSTR appName, LPCWSTR company) throw ()

	CrashRpt (LPCSTR applicationGUID, LPCSTR prefix, LPCWSTR appName, LPCWSTR company, BOOL ownProcess=TRUE) throw ()

	CrashRpt (LPCWSTR crashrptPath, LPCSTR applicationGUID, LPCSTR prefix, LPCWSTR appName, LPCWSTR company, BOOL ownProcess=TRUE) throw ()

	CrashRpt (ApplicationInfo applicationInfo, HandlerSettings handlerSettings, BOOL ownProcess=TRUE) throw ()

	CrashRpt (LPCWSTR crashrptPath, ApplicationInfo applicationInfo, HandlerSettings handlerSettings, BOOL ownProcess=TRUE) throw ()

	CrashRpt (LPCWSTR crashrptPath=NULL) throw ()

	~CrashRpt ()

bool	IsCrashHandlingEnabled () const

bool	InitCrashRpt (ApplicationInfo applicationInfo, HandlerSettings handlerSettings, BOOL ownProcess=TRUE) throw ()

bool	InitCrashRpt (LPCSTR applicationGUID, LPCSTR prefix, LPCWSTR appName, LPCWSTR company, BOOL ownProcess=TRUE) throw ()

bool	SetCustomInfo (LPCWSTR text)

bool	AddUserInfoToReport (LPCWSTR key, LPCWSTR value) throw ()

bool	RemoveUserInfoFromReport (LPCWSTR key)

bool	AddFileToReport (LPCWSTR path, LPCWSTR reportFileName) throw ()

bool	RemoveFileFromReport (LPCWSTR path) throw ()

bool	GetVersionFromApp (ApplicationInfo *appInfo) throw ()

bool	GetVersionFromFile (LPCWSTR path, ApplicationInfo *appInfo) throw ()

LONG	SendReport (EXCEPTION_POINTERS *exceptionPointers)

void	SkipDoctorDump_SendAssertionViolated (LPCSTR dumpGroup=NULL) const

Static Public Attributes
static const DWORD	ExceptionAssertionViolated = ((DWORD)0xCCE17000)

static const DWORD	ExceptionCppTerminate = ((DWORD)0xCCE17001)
	Exception code for Terminate()/SIGABRT call in crash callback.

static const DWORD	ExceptionPureCall = ((DWORD)0xCCE17002)
	Exception code for pure virtual call in crash callback.

static const DWORD	ExceptionInvalidParameter = ((DWORD)0xCCE17003)
	Exception code for CRT invalid parameter call in crash callback.

Detailed Description

To enable crash processing you should create an instance of this class.

It should be created as global static object and correctly initialized. Also you may instantiate it in your main() or WinMain() function as soon as possible.

Examples:: Sample.cpp.

Constructor & Destructor Documentation

◆ CrashRpt() [1/6]

crash_rpt::CrashRpt::CrashRpt	(	LPCSTR	applicationGUID,
		LPCWSTR	appName,
		LPCWSTR	company
	)
throw	(
	)

inline

CrashRpt constructor. Loads crashrpt.dll and initializes crash handling.

Note: The crashrpt.dll is allowed to be missing. In that case there will be no crash handling.

Parameters

[in]	applicationGUID	GUID assigned to this application.
[in]	appName	Application name that will be shown in message box.
[in]	company	Company name that will be shown in message box.

◆ CrashRpt() [2/6]

crash_rpt::CrashRpt::CrashRpt	(	LPCSTR	applicationGUID,
		LPCSTR	prefix,
		LPCWSTR	appName,
		LPCWSTR	company,
		BOOL	ownProcess = `TRUE`
	)
throw	(
	)

inline

CrashRpt constructor. Loads crashrpt.dll and initializes crash handling.

Note: The crashrpt.dll is allowed to be missing. In that case there will be no crash handling.

Parameters

[in]	applicationGUID	GUID assigned to this application.
[in]	prefix	Prefix that will be used with the dump name: YourPrefix_v1.v2.v3.v4_YYYYMMDD_HHMMSS.mini.dmp.
[in]	appName	Application name that will be shown in message box.
[in]	company	Company name that will be shown in message box.
[in]	ownProcess	If you own the process your code running in set this option to TRUE. If don't (for example you write a plugin to some external application) set this option to FALSE. In that case you need to explicitly catch exceptions. See SendReport for more information.

◆ CrashRpt() [3/6]

crash_rpt::CrashRpt::CrashRpt	(	LPCWSTR	crashrptPath,
		LPCSTR	applicationGUID,
		LPCSTR	prefix,
		LPCWSTR	appName,
		LPCWSTR	company,
		BOOL	ownProcess = `TRUE`
	)
throw	(
	)

inline

CrashRpt constructor. Loads crashrpt.dll and initializes crash handling.

Note: The crashrpt.dll is allowed to be missing. In that case there will be no crash handling.

Parameters

[in]	crashrptPath	Path to crashrpt.dll file. File may be renamed.
[in]	applicationGUID	GUID assigned to this application.
[in]	prefix	Prefix that will be used with the dump name: YourPrefix_v1.v2.v3.v4_YYYYMMDD_HHMMSS.mini.dmp.
[in]	appName	Application name that will be shown in message box.
[in]	company	Company name that will be shown in message box.
[in]	ownProcess	If you own the process your code running in set this option to TRUE. If don't (for example you write a plugin to some external application) set this option to FALSE. In that case you need to explicitly catch exceptions. See SendReport for more information.

◆ CrashRpt() [4/6]

crash_rpt::CrashRpt::CrashRpt	(	ApplicationInfo *	applicationInfo,
		HandlerSettings *	handlerSettings,
		BOOL	ownProcess = `TRUE`
	)
throw	(
	)

inline

CrashRpt constructor. Loads crashrpt.dll and initializes crash handling.

Note: The crashrpt.dll is allowed to be missing. In that case there will be no crash handling.

Parameters

[in]	applicationInfo	Pointer to the ApplicationInfo structure that identifies your application.
[in]	handlerSettings	Pointer to the HandlerSettings structure that customizes crash handling behavior. This parameter can be NULL.
[in]	ownProcess	If you own the process your code running in set this option to TRUE. If don't (for example you write a plugin to some external application) set this option to FALSE. In that case you need to explicitly catch exceptions. See SendReport for more information.

◆ CrashRpt() [5/6]

crash_rpt::CrashRpt::CrashRpt	(	LPCWSTR	crashrptPath,
		ApplicationInfo *	applicationInfo,
		HandlerSettings *	handlerSettings,
		BOOL	ownProcess = `TRUE`
	)
throw	(
	)

inline

CrashRpt constructor. Loads crashrpt.dll and initializes crash handling.

Note: The crashrpt.dll is allowed to be missing. In that case there will be no crash handling.

Parameters

[in]	crashrptPath	Path to crashrpt.dll file. File may be renamed.
[in]	applicationInfo	Pointer to the ApplicationInfo structure that identifies your application.
[in]	handlerSettings	Pointer to the HandlerSettings structure that customizes crash handling behavior. This parameter can be NULL.
[in]	ownProcess	If you own the process your code running in set this option to TRUE. If don't (for example you write a plugin to some external application) set this option to FALSE. In that case you need to explicitly catch exceptions. See SendReport for more information.

◆ CrashRpt() [6/6]

crash_rpt::CrashRpt::CrashRpt	(	LPCWSTR	crashrptPath = `NULL`	)
throw	(
	)

inline

CrashRpt constructor. Loads crashrpt.dll. You should call InitCrashRpt to turn on crash handling.

Note: The crashrpt.dll is allowed to be missing. In that case there will be no crash handling.

Parameters

[in] crashrptPath Path to crashrpt.dll file. File may be renamed.

◆ ~CrashRpt()

crash_rpt::CrashRpt::~CrashRpt ( )

inline

CrashRpt destructor.

Note: It doesn't unload crashrpt.dll and doesn't disable crash handling since crash may appear on very late phase of application exit. For example destructor of some static variable that is called after return from main() may crash.

Member Function Documentation

◆ AddFileToReport()

bool crash_rpt::CrashRpt::AddFileToReport	(	LPCWSTR	path,
		LPCWSTR	reportFileName
	)
throw	(
	)

inline

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.

Note: The file should be accessible with GENERIC_READ access and FILE_SHARE_READ share mode. If your program uses this file with another access options (for example this is log file and it is open for writing) you should release the file in crash_rpt::HandlerSettings::CrashProcessingCallback on BeforeSendReport stage.; This function is thread safe.

Parameters

[in]	path	Path to the file, that will be added to the report.
[in]	reportFileName	Filename that will be used in report for this file. If parameter is NULL, original name from path will be used.

◆ AddUserInfoToReport()

bool crash_rpt::CrashRpt::AddUserInfoToReport	(	LPCWSTR	key,
		LPCWSTR	value
	)
throw	(
	)

inline

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

Returns: If the function succeeds, the return value is true.

Note: This function is thread safe.

Parameters

[in]	key	key string that will be added to the report.
[in]	value	value for the key.

◆ GetVersionFromApp()

bool crash_rpt::CrashRpt::GetVersionFromApp	(	ApplicationInfo *	appInfo	)
throw	(
	)

inline

Fills version field (V) of ApplicationInfo with product version found in the executable file of the current process.

Returns: If the function succeeds, the return value is true.

Parameters

[out] appInfo Pointer to ApplicationInfo structure. Its version field (V) will be set to product version.

◆ GetVersionFromFile()

bool crash_rpt::CrashRpt::GetVersionFromFile	(	LPCWSTR	path,
		ApplicationInfo *	appInfo
	)
throw	(
	)

inline

Fill version field (V) of ApplicationInfo with product version found in the file specified.

Returns: If the function succeeds, the return value is true.

Parameters

[in]	path	Path to the file product version will be extracted from.
[out]	appInfo	Pointer to ApplicationInfo structure. Its version field (V) will be set to product version.

◆ InitCrashRpt() [1/2]

bool crash_rpt::CrashRpt::InitCrashRpt	(	ApplicationInfo *	applicationInfo,
		HandlerSettings *	handlerSettings,
		BOOL	ownProcess = `TRUE`
	)
throw	(
	)

inline

Initializes crash handler.

Note: You may call this function multiple times if some data has changed.

Returns: Return true if crash handling was enabled.

Parameters

[in]	applicationInfo	Pointer to the ApplicationInfo structure that identifies your application.
[in]	handlerSettings	Pointer to the HandlerSettings structure that customizes crash handling behavior. This parameter can be NULL.
[in]	ownProcess	If you own the process your code running in set this option to TRUE. If don't (for example you write a plugin to some external application) set this option to FALSE. In that case you need to explicitly catch exceptions. See SendReport for more information.

◆ InitCrashRpt() [2/2]

bool crash_rpt::CrashRpt::InitCrashRpt	(	LPCSTR	applicationGUID,
		LPCSTR	prefix,
		LPCWSTR	appName,
		LPCWSTR	company,
		BOOL	ownProcess = `TRUE`
	)
throw	(
	)

inline

Initializes crash handler.

Note: You may call this function multiple times if some data has changed.

Returns: Return true if crash handling was enabled.

Parameters

[in]	applicationGUID	GUID assigned to this application.
[in]	prefix	Prefix that will be used with the dump name: YourPrefix_v1.v2.v3.v4_YYYYMMDD_HHMMSS.mini.dmp.
[in]	appName	Application name that will be shown in message box.
[in]	company	Company name that will be shown in message box.
[in]	ownProcess	If you own the process your code running in set this option to TRUE. If don't (for example you write a plugin to some external application) set this option to FALSE. In that case you need to explicitly catch exceptions. See SendReport for more information.

◆ IsCrashHandlingEnabled()

bool crash_rpt::CrashRpt::IsCrashHandlingEnabled ( ) const

inline

Checks that crash handling was enabled.

Returns: Return true if crash handling was enabled.

◆ RemoveFileFromReport()

bool crash_rpt::CrashRpt::RemoveFileFromReport	(	LPCWSTR	path	)
throw	(
	)

inline

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

Returns: If the function succeeds, the return value is true.

Note: This function is thread safe.

Parameters

[in] path Path to the file, that will be removed from the report.

◆ RemoveUserInfoFromReport()

bool crash_rpt::CrashRpt::RemoveUserInfoFromReport ( LPCWSTR key )

inline

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

Returns: If the function succeeds, the return value is true.

Note: This function is thread safe.

Parameters

[in] key key string that will be removed from the report.

◆ SendReport()

LONG crash_rpt::CrashRpt::SendReport ( EXCEPTION_POINTERS * exceptionPointers )

inline

If you do not own the process your code running in (for example you write a plugin to some external application) you need to properly initialize CrashRpt using ownProcess option. Also you need to explicitly catch all exceptions in all entry points to your code and in all threads you create. To do so use this construction:

bool SomeEntryPoint(PARAM p)
{
    __try
    {
        return YouCode(p);
    }
    __except (CrashRpt::SendReport(GetExceptionInformation()))
    {
        ::ExitProcess(0); // It is better to stop the process here or else corrupted data may incomprehensibly crash it later.
        return false;
    }
}

Parameters

[in] exceptionPointers Pointer to EXCEPTION_POINTERS structure. You should get it using GetExceptionInformation() function inside __except keyword.

◆ SetCustomInfo()

bool crash_rpt::CrashRpt::SetCustomInfo ( LPCWSTR text )

inline

You may set custom information for your possible report. This text will be available on Doctor Dump dumps page. The text should not contain private information.

Warning: This function is experimental and may not be available and may not be support by Doctor Dump in the future.

Returns: If the function succeeds, the return value is true.

Parameters

[in] text custom info for the report. The text will be cut to 100 characters.

◆ SkipDoctorDump_SendAssertionViolated()

void crash_rpt::CrashRpt::SkipDoctorDump_SendAssertionViolated ( LPCSTR dumpGroup = NULL ) const

inline

Sends assertion violation report from this point and continue execution.

See also: ExceptionAssertionViolated

Note: Functions containing "SkipDoctorDump" will be ignored in stack parsing.

See also: CRASHRPT_ENABLE_RELEASE_ASSERTS ExceptionAssertionViolated

Parameters

[in] dumpGroup All dumps with that group will be separated from dumps with same stack but another group. Set parameter to NULL if no grouping is required.

Member Data Documentation

◆ ExceptionAssertionViolated

const DWORD crash_rpt::CrashRpt::ExceptionAssertionViolated = ((DWORD)0xCCE17000)

static

To send a report about violated assertion you can throw exception with this exception code using:

RaiseException(CrashRpt::ExceptionAssertionViolated, 0, 0, NULL);

Execution will continue after report will be sent (EXCEPTION_CONTINUE_EXECUTION would be used). You may pass grouping string as first parameter (see SkipDoctorDump_SendAssertionViolated).

Note: If you called CrashRpt constructor and crashrpt.dll was missing you still may using this exception. It will be caught, ignored and execution will continue. SendReport function also works safely when crashrpt.dll was missing.

See also: CRASHRPT_ENABLE_RELEASE_ASSERTS SkipDoctorDump_SendAssertionViolated

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CrashRpt() [1/6]

◆ CrashRpt() [2/6]

◆ CrashRpt() [3/6]

◆ CrashRpt() [4/6]

◆ CrashRpt() [5/6]

◆ CrashRpt() [6/6]

◆ ~CrashRpt()

Member Function Documentation

◆ AddFileToReport()

◆ AddUserInfoToReport()

◆ GetVersionFromApp()

◆ GetVersionFromFile()

◆ InitCrashRpt() [1/2]

◆ InitCrashRpt() [2/2]

◆ IsCrashHandlingEnabled()

◆ RemoveFileFromReport()

◆ RemoveUserInfoFromReport()

◆ SendReport()

◆ SetCustomInfo()

◆ SkipDoctorDump_SendAssertionViolated()

Member Data Documentation

◆ ExceptionAssertionViolated