BugTrap: Common type definitions

BugTrap

previous page next page

Common type definitions


Classes
struct	BUGTRAP_LOGFILEENTRY_tag
	Log file entry structure return by BT_GetLogFileEntry() for regular log files. More...
struct	BUGTRAP_REGEXPORTENTRY_tag
	Log file entry structure return by BT_GetLogFileEntry() for log files exported from the registry. More...
Typedefs
typedef void(CALLBACK *	BT_ErrHandler )(INT_PTR nErrHandlerParam)
	Type definition of user-defined error handler that's called before and after main BugTrap dialog.
typedef enum BUGTRAP_ACTIVITY_tag	BUGTRAP_ACTIVITY
	Type of action which is performed in response to the error.
typedef enum BUGTRAP_DIALOGMESSAGE_tag	BUGTRAP_DIALOGMESSAGE
	Type of user defined message displayed on the screen.
typedef enum BUGTRAP_EXITMODE_tag	BUGTRAP_EXITMODE
	These flags control application termination mode: whatever the application needs to be terminated after error handling, control should passed to another exception handler.
typedef enum BUGTRAP_FLAGS_tag	BUGTRAP_FLAGS
	Different BugTrap options. You can use any combinations of these flags.
typedef enum BUGTRAP_LOGECHOTYPE_tag	BUGTRAP_LOGECHOTYPE
	Type of log echo mode.
typedef struct BUGTRAP_LOGFILEENTRY_tag	BUGTRAP_LOGFILEENTRY
	Log file entry structure return by BT_GetLogFileEntry() for regular log files.
typedef enum BUGTRAP_LOGFLAGS_tag	BUGTRAP_LOGFLAGS
	Set of log file options.
typedef enum BUGTRAP_LOGFORMAT_tag	BUGTRAP_LOGFORMAT
	Format of log file.
typedef enum BUGTRAP_LOGLEVEL_tag	BUGTRAP_LOGLEVEL
	Set of available log levels.
typedef enum BUGTRAP_LOGTYPE_tag	BUGTRAP_LOGTYPE
	Type of log file attached to the report.
typedef struct BUGTRAP_REGEXPORTENTRY_tag	BUGTRAP_REGEXPORTENTRY
	Log file entry structure return by BT_GetLogFileEntry() for log files exported from the registry.
typedef enum BUGTRAP_REPORTFORMAT_tag	BUGTRAP_REPORTFORMAT
	Format of error report.
Enumerations
enum	BUGTRAP_ACTIVITY_tag { BTA_SHOWUI = 1, BTA_SAVEREPORT = 2, BTA_MAILREPORT = 3, BTA_SENDREPORT = 4 }
	Type of action which is performed in response to the error. More...
enum	BUGTRAP_DIALOGMESSAGE_tag { BTDM_INTRO1 = 1, BTDM_INTRO2 = 2 }
	Type of user defined message displayed on the screen. More...
enum	BUGTRAP_EXITMODE_tag { BTEM_TERMINATEAPP, BTEM_CONTINUESEARCH, BTEM_EXECUTEHANDLER }
	These flags control application termination mode: whatever the application needs to be terminated after error handling, control should passed to another exception handler. More...
enum	BUGTRAP_FLAGS_tag { BTF_NONE = 0x00, BTF_DETAILEDMODE = 0x01, BTF_EDITMAIL = 0x02, BTF_ATTACHREPORT = 0x04, BTF_LISTPROCESSES = 0x08, BTF_SHOWADVANCEDUI = 0x10, BTF_SCREENCAPTURE = 0x20, BTF_INTERCEPTSUEF = 0x80 }
	Different BugTrap options. You can use any combinations of these flags. More...
enum	BUGTRAP_LOGECHOTYPE_tag { BTLE_NONE = 0x00, BTLE_STDOUT = 0x01, BTLE_STDERR = 0x02, BTLE_DBGOUT = 0x04 }
	Type of log echo mode. More...
enum	BUGTRAP_LOGFLAGS_tag { BTLF_NONE = 0x00, BTLF_SHOWLOGLEVEL = 0x01, BTLF_SHOWTIMESTAMP = 0x02 }
	Set of log file options. More...
enum	BUGTRAP_LOGFORMAT_tag { BTLF_XML = 1, BTLF_TEXT = 2, BTLF_STREAM = 3 }
	Format of log file. More...
enum	BUGTRAP_LOGLEVEL_tag { BTLL_NONE = 0, BTLL_ERROR = 1, BTLL_WARNING = 2, BTLL_IMPORTANT = 3, BTLL_INFO = 4, BTLL_VERBOSE = 5, BTLL_ALL = BTLL_INFO }
	Set of available log levels. More...
enum	BUGTRAP_LOGTYPE_tag { BTLT_LOGFILE, BTLT_REGEXPORT }
	Type of log file attached to the report. More...
enum	BUGTRAP_REPORTFORMAT_tag { BTRF_XML = 1, BTRF_TEXT = 2 }
	Format of error report. More...

Typedef Documentation

typedef void(CALLBACK * BT_ErrHandler)(INT_PTR nErrHandlerParam)

Type definition of user-defined error handler that's called before and after main BugTrap dialog.

typedef enum BUGTRAP_ACTIVITY_tag BUGTRAP_ACTIVITY

Type of action which is performed in response to the error.

typedef enum BUGTRAP_DIALOGMESSAGE_tag BUGTRAP_DIALOGMESSAGE

Type of user defined message displayed on the screen.

typedef enum BUGTRAP_EXITMODE_tag BUGTRAP_EXITMODE

These flags control application termination mode: whatever the application needs to be terminated after error handling, control should passed to another exception handler.

typedef enum BUGTRAP_FLAGS_tag BUGTRAP_FLAGS

Different BugTrap options. You can use any combinations of these flags.

typedef enum BUGTRAP_LOGECHOTYPE_tag BUGTRAP_LOGECHOTYPE

Type of log echo mode.

typedef struct BUGTRAP_LOGFILEENTRY_tag BUGTRAP_LOGFILEENTRY

Log file entry structure return by BT_GetLogFileEntry() for regular log files.

typedef enum BUGTRAP_LOGFLAGS_tag BUGTRAP_LOGFLAGS

Set of log file options.

typedef enum BUGTRAP_LOGFORMAT_tag BUGTRAP_LOGFORMAT

Format of log file.

typedef enum BUGTRAP_LOGLEVEL_tag BUGTRAP_LOGLEVEL

Set of available log levels.

typedef enum BUGTRAP_LOGTYPE_tag BUGTRAP_LOGTYPE

Type of log file attached to the report.

typedef struct BUGTRAP_REGEXPORTENTRY_tag BUGTRAP_REGEXPORTENTRY

Log file entry structure return by BT_GetLogFileEntry() for log files exported from the registry.

typedef enum BUGTRAP_REPORTFORMAT_tag BUGTRAP_REPORTFORMAT

Format of error report.

Enumeration Type Documentation

enum BUGTRAP_ACTIVITY_tag

Type of action which is performed in response to the error.

Enumerator:

BTA_SHOWUI	Display BugTrap dialog to allow user selecting desirable option. This is the default option.
BTA_SAVEREPORT	Automatically save error report to file. Use BT_SetReportFilePath() to specify report path.
BTA_MAILREPORT	Automatically send error report by e-mail.
BTA_SENDREPORT	Automatically send bug report to support server.

enum BUGTRAP_DIALOGMESSAGE_tag

Type of user defined message displayed on the screen.

Enumerator:

BTDM_INTRO1	1st line of introduction message.
BTDM_INTRO2	A bunch of lines of introduction message.

enum BUGTRAP_EXITMODE_tag

These flags control application termination mode: whatever the application needs to be terminated after error handling, control should passed to another exception handler.

Enumerator:

BTEM_TERMINATEAPP	BugTrap executes desirable action (usually displays the dialog). The application is being terminated when user closes the dialog. This is default action.
BTEM_CONTINUESEARCH	BugTrap executes desirable action and continues to search up the stack for a handler.
BTEM_EXECUTEHANDLER	BugTrap executes desirable action and transfers control to the exception handlers.

enum BUGTRAP_FLAGS_tag

Different BugTrap options. You can use any combinations of these flags.

Enumerator:

BTF_NONE	Equivalent of no options.
BTF_DETAILEDMODE	In detailed mode BugTrap generates mini-dump and packs custom log files within the report.
BTF_EDITMAIL	BugTrap may open its own editor for e-mail messages instead of the editor used by the system. Use this option if you aren't aware of the type of e-mail client installed on user computers.
BTF_ATTACHREPORT	Specify this option to attach bug report to e-mail messages. Be careful with this option. It's potentially dangerous for the detailed mode because of even zipped mini-dump may require huge size. It may exceed the maximum size of e-mail message supported by Internet provider.
BTF_LISTPROCESSES	Set this flag to add list of all processes and loaded modules to the report. Disable this option to speedup report generation.
BTF_SHOWADVANCEDUI	By default BugTrap displays simplified dialog on the screen allowing user to perform only common actions. Enable this flag to immediately display dialog with advanced error information.
BTF_SCREENCAPTURE	Bug report in detailed error mode may also include a screen shot automatically captured by BugTrap. By default this option is disabled to minimize report size, but it may be useful if you want to know which dialogs were shown on the screen.
BTF_INTERCEPTSUEF	When enabled, BugTrap injects fake SetUnhandledExceptionFilter() to handle the most severe C runtime errors. Usually such errors are not being reported to custom unhandled exception filters. This flag vanishes any attempts of C runtime library to override unhandled exception filter defined in BugTrap. This option should be used with caution, because such technique may be incompatible with future Windows versions.

enum BUGTRAP_LOGECHOTYPE_tag

Type of log echo mode.

Enumerator:

BTLE_NONE	Do not duplicate log output to file.
BTLE_STDOUT	Send a copy of log output to STDOUT (mutually exclusive with STDERR mode).
BTLE_STDERR	Send a copy of log output to STDERR (mutually exclusive with STDOUT mode).
BTLE_DBGOUT	Send a copy of log output to the debugger (can accompany STDOUT or STDERR mode).

enum BUGTRAP_LOGFLAGS_tag

Set of log file options.

Enumerator:

BTLF_NONE	Do not show any additional entries in the log.
BTLF_SHOWLOGLEVEL	Use this option if you want to store message levels in a file.
BTLF_SHOWTIMESTAMP	Use this option if you want to store message timestamps in a file. Timestamps are stored in universal (locale independent) format: YYYY/MM/DD HH:MM:SS.

enum BUGTRAP_LOGFORMAT_tag

Format of log file.

Enumerator:

BTLF_XML	Log stored in structured XML format. Log data is entirely stored in memory until application exists or crashes. It is designed for fast IO and it cannot handle large logs.
BTLF_TEXT	Log stored in plain text format. Log data is entirely stored in memory until application exists or crashes. It is designed for fast IO and it cannot handle large logs.
BTLF_STREAM	Log stored in plain text format. Unlike BTLF_XML and BTLF_TEXT log data is not cached in memory. This type of log is optimized for large logs.

enum BUGTRAP_LOGLEVEL_tag

Set of available log levels.

Enumerator:

BTLL_NONE	All message levels are prohibited.
BTLL_ERROR	Error message.
BTLL_WARNING	Waning message.
BTLL_IMPORTANT	Important information message.
BTLL_INFO	Regular information message.
BTLL_VERBOSE	Verbose information message.
BTLL_ALL	All levels of messages are accepted.