BugTrap.h File Reference
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... | |
Defines | |
| #define | BT_DO_NOT_USE_DEFAULT_NAMESPACES |
| #define | BT_SetTerminate() |
| #define | BUGTRAP_API __declspec(dllimport) |
| #define | BUGTRAP_HTTP_PORT 80 |
| Use this port for HTTP protocol. | |
| #define | MiniDumpNoDump MAXDWORD |
| Disables mini-dump generation in detailed mode. | |
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... | |
Functions | |
| BUGTRAP_API void APIENTRY | BT_AddLogFile (LPCTSTR pszLogFile) |
| Add custom log entry to the list of custom log files attached to bug report. | |
| BUGTRAP_API void APIENTRY | BT_AddRegFile (LPCTSTR pszRegFile, LPCTSTR pszRegKey) |
| Add custom log entry to the list of custom log files attached to bug report. | |
| BUGTRAP_API BOOL APIENTRY | BT_AppLogEntry (INT_PTR iHandle, BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszEntry) |
| Append entry to the end of custom log file. This function is thread safe. | |
| BUGTRAP_API BOOL CDECL | BT_AppLogEntryF (INT_PTR iHandle, BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszFormat,...) |
| Append entry to the end of custom log file. This function is thread safe. | |
| BUGTRAP_API BOOL APIENTRY | BT_AppLogEntryV (INT_PTR iHandle, BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszFormat, va_list argList) |
| Append entry to the end of custom log file. This function is thread safe. | |
| BUGTRAP_API void CDECL | BT_CallCppFilter (void) |
| Simulates access violation in C++ application. Used by set_terminate(). | |
| BUGTRAP_API void CDECL | BT_CallSehFilter (void) |
| Simulates access violation in C++ application. Used by set_terminate(). | |
| BUGTRAP_API BOOL APIENTRY | BT_ClearLog (INT_PTR iHandle) |
| Clear log file. This function is thread safe. | |
| BUGTRAP_API void APIENTRY | BT_ClearLogFiles (void) |
| Clear the list of custom log files attached to bug report. | |
| BUGTRAP_API BOOL APIENTRY | BT_CloseLogFile (INT_PTR iHandle) |
| Close custom log file. This function is thread safe. | |
| BUGTRAP_API LONG CALLBACK | BT_CppFilter (PEXCEPTION_POINTERS pExceptionPointers) |
| Executes C++ exception filter. | |
| BUGTRAP_API void APIENTRY | BT_DeleteLogFile (LPCTSTR pszLogFile) |
| Delete custom log entry from the list of custom log files attached to bug report. | |
| BUGTRAP_API int APIENTRY | BT_ExportRegistryKey (LPCTSTR pszRegFile, LPCTSTR pszRegKey) |
| Export registry key to the file. | |
| BUGTRAP_API BOOL APIENTRY | BT_FlushLogFile (INT_PTR iHandle) |
| Flush contents of the log file. | |
| BUGTRAP_API BUGTRAP_ACTIVITY APIENTRY | BT_GetActivityType (void) |
| Get the type of action which is performed in response to the error. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetAppName (void) |
| Get application name. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetAppVersion (void) |
| Get application version number. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetDialogMessage (BUGTRAP_DIALOGMESSAGE eDialogMessage) |
| Get user defined message displayed on the screen. | |
| BUGTRAP_API DWORD APIENTRY | BT_GetDumpType (void) |
| Get the type of produced mini-dump in detailed mode. | |
| BUGTRAP_API BUGTRAP_EXITMODE APIENTRY | BT_GetExitMode (void) |
| Get application termination mode. | |
| BUGTRAP_API DWORD APIENTRY | BT_GetFlags (void) |
| Get current BugTrap options. | |
| BUGTRAP_API DWORD APIENTRY | BT_GetLogEchoMode (INT_PTR iHandle) |
| Get echo mode. | |
| BUGTRAP_API DWORD APIENTRY | BT_GetLogFileEntry (INT_PTR nLogFileIndexOrName, BOOL bGetByIndex, BUGTRAP_LOGTYPE *peLogType, PDWORD pdwLogEntrySize, PVOID pLogEntry) |
| This function enumerates log file entries that will be attached to the report. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetLogFileName (INT_PTR iHandle) |
| Get custom log file name. This function is thread safe. | |
| BUGTRAP_API DWORD APIENTRY | BT_GetLogFilesCount (void) |
| Get number of log files attached to the report. | |
| BUGTRAP_API DWORD APIENTRY | BT_GetLogFlags (INT_PTR iHandle) |
| Return true if time stamp is added to every log entry. | |
| BUGTRAP_API BUGTRAP_LOGLEVEL APIENTRY | BT_GetLogLevel (INT_PTR iHandle) |
| Return minimal log level accepted by tracing functions. | |
| BUGTRAP_API DWORD APIENTRY | BT_GetLogSizeInBytes (INT_PTR iHandle) |
| Get maximum log file size in bytes. This function is thread safe. | |
| BUGTRAP_API DWORD APIENTRY | BT_GetLogSizeInEntries (INT_PTR iHandle) |
| Get maximum log file size in records. This function is thread safe. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetMailProfile (void) |
| Get the name of MAPI profile. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetNotificationEMail (void) |
| Get error notification e-mail address. BugTrap Server may automatically notify product support by e-mail about new bug reports. | |
| BUGTRAP_API BT_ErrHandler APIENTRY | BT_GetPostErrHandler (void) |
| Get address of error handler called after BugTrap dialog. | |
| BUGTRAP_API BT_ErrHandler APIENTRY | BT_GetPreErrHandler (void) |
| Get address of error handler called before BugTrap dialog. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetReportFilePath (void) |
| Get the path of error report. | |
| BUGTRAP_API BUGTRAP_REPORTFORMAT APIENTRY | BT_GetReportFormat (void) |
| Get format of error report. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetSupportEMail (void) |
| Get product support e-mail address. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetSupportHost (void) |
| Get host name of BugTrap Server. This server can automatically gather bug reports for the application. | |
| BUGTRAP_API SHORT APIENTRY | BT_GetSupportPort (void) |
| Get port number of BugTrap Server. This server can automatically gather bug reports for the application. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetSupportURL (void) |
| Get HTTP address of product support site. | |
| BUGTRAP_API LPCTSTR APIENTRY | BT_GetUserMessage (void) |
| Get user defined message. This message may be printed to a log file. | |
| BUGTRAP_API BOOL APIENTRY | BT_InsLogEntry (INT_PTR iHandle, BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszEntry) |
| Insert entry into the beginning of custom log file. This function is thread safe. | |
| BUGTRAP_API BOOL CDECL | BT_InsLogEntryF (INT_PTR iHandle, BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszFormat,...) |
| Insert entry into the beginning of custom log file. This function is thread safe. | |
| BUGTRAP_API BOOL APIENTRY | BT_InsLogEntryV (INT_PTR iHandle, BUGTRAP_LOGLEVEL eLogLevel, LPCTSTR pszFormat, va_list argList) |
| Insert entry into the beginning of custom log file. This function is thread safe. | |
| BUGTRAP_API LPTOP_LEVEL_EXCEPTION_FILTER APIENTRY | BT_InstallSehFilter (void) |
| BUGTRAP_API void | BT_InterceptSUEF (HMODULE hModule, BOOL bOverride) |
| Explicitly intercepts SetUnhandledExceptionFilter() in a module. This function could be useful for dynamically loaded modules. | |
| BUGTRAP_API BOOL APIENTRY | BT_MailSnapshot (void) |
| Take a snapshot of program memory and e-mail it. | |
| BUGTRAP_API BOOL APIENTRY | BT_MailSnapshotEx (PEXCEPTION_POINTERS pExceptionPointers) |
| Take a snapshot of program memory and e-mail it. | |
| BUGTRAP_API INT_PTR APIENTRY | BT_OpenLogFile (LPCTSTR pszLogFileName, BUGTRAP_LOGFORMAT eLogFormat) |
| Open custom log file. This function is thread safe. | |
| BUGTRAP_API BOOL APIENTRY | BT_ReadVersionInfo (HMODULE hModule) |
| Read application name and version number from version info block. | |
| BUGTRAP_API BOOL APIENTRY | BT_SaveSnapshot (PCTSTR pszFileName) |
| Take a snapshot of program memory and save it to a file. | |
| BUGTRAP_API BOOL APIENTRY | BT_SaveSnapshotEx (PEXCEPTION_POINTERS pExceptionPointers, PCTSTR pszFileName) |
| Take a snapshot of program memory and save it to a file. | |
| BUGTRAP_API LONG CALLBACK | BT_SehFilter (PEXCEPTION_POINTERS pExceptionPointers) |
| Executes structured exception filter. | |
| BUGTRAP_API BOOL APIENTRY | BT_SendSnapshot (void) |
| Take a snapshot of program memory and send over network. | |
| BUGTRAP_API BOOL APIENTRY | BT_SendSnapshotEx (PEXCEPTION_POINTERS pExceptionPointers) |
| Take a snapshot of program memory and send over network. | |
| BUGTRAP_API void APIENTRY | BT_SetActivityType (BUGTRAP_ACTIVITY eActivityType) |
| Set the type of action which is performed in response to the error. | |
| BUGTRAP_API void APIENTRY | BT_SetAppName (LPCTSTR pszAppName) |
| Set application name of the project where BugTrap is used. | |
| BUGTRAP_API void APIENTRY | BT_SetAppVersion (LPCTSTR pszAppVersion) |
| Set application version number. | |
| BUGTRAP_API void APIENTRY | BT_SetDialogMessage (BUGTRAP_DIALOGMESSAGE eDialogMessage, LPCTSTR pszMessage) |
| Set user defined message displayed on the screen. | |
| BUGTRAP_API void APIENTRY | BT_SetDumpType (DWORD dwDumpType) |
| Set the type of produced mini-dump in detailed mode. | |
| BUGTRAP_API void APIENTRY | BT_SetExitMode (BUGTRAP_EXITMODE eExitMode) |
| Set application termination mode. | |
| BUGTRAP_API void APIENTRY | BT_SetFlags (DWORD dwFlags) |
| Set various BugTrap options. | |
| BUGTRAP_API BOOL APIENTRY | BT_SetLogEchoMode (INT_PTR iHandle, DWORD dwLogEchoMode) |
| Set echo mode. | |
| BUGTRAP_API BOOL APIENTRY | BT_SetLogFlags (INT_PTR iHandle, DWORD dwLogFlags) |
| Set true if time stamp is added to every log entry. | |
| BUGTRAP_API BOOL APIENTRY | BT_SetLogLevel (INT_PTR iHandle, BUGTRAP_LOGLEVEL eLogLevel) |
| Set minimal log level accepted by tracing functions. | |
| BUGTRAP_API BOOL APIENTRY | BT_SetLogSizeInBytes (INT_PTR iHandle, DWORD dwLogSizeInEntries) |
| Set maximum log file size in bytes. This function is thread safe. | |
| BUGTRAP_API BOOL APIENTRY | BT_SetLogSizeInEntries (INT_PTR iHandle, DWORD dwLogSizeInEntries) |
| Set maximum log file size in records. This function is thread safe. | |
| BUGTRAP_API void APIENTRY | BT_SetMailProfile (LPCTSTR pszMailProfile, LPCTSTR pszMailPassword) |
| Set the name and password of MAPI profile. | |
| BUGTRAP_API void APIENTRY | BT_SetNotificationEMail (LPCTSTR pszNotificationEMail) |
| Set error notification e-mail address. BugTrap Server may automatically notify product support by e-mail about new bug reports. | |
| BUGTRAP_API void APIENTRY | BT_SetPostErrHandler (BT_ErrHandler pfnPostErrHandler, INT_PTR nPostErrHandlerParam) |
| Set address of error handler called after BugTrap dialog. | |
| BUGTRAP_API void APIENTRY | BT_SetPreErrHandler (BT_ErrHandler pfnPreErrHandler, INT_PTR nPreErrHandlerParam) |
| Set address of error handler called before BugTrap dialog. | |
| BUGTRAP_API void APIENTRY | BT_SetReportFilePath (LPCTSTR pszReportFilePath) |
| Set the path of error report. This function has effect only for BTA_SAVEREPORT activity. | |
| BUGTRAP_API void APIENTRY | BT_SetReportFormat (BUGTRAP_REPORTFORMAT eReportFormat) |
| Set format of error report. | |
| BUGTRAP_API void APIENTRY | BT_SetSupportEMail (LPCTSTR pszSupportEMail) |
| Set product support e-mail address. | |
| BUGTRAP_API void APIENTRY | BT_SetSupportHost (LPCTSTR pszSupportHost) |
| Set host name (address) of BugTrap Server. This server can automatically gather bug reports for the application. | |
| BUGTRAP_API void APIENTRY | BT_SetSupportPort (SHORT nSupportPort) |
| Set port number of BugTrap Server. This server can automatically gather bug reports for the application. | |
| BUGTRAP_API void APIENTRY | BT_SetSupportServer (LPCTSTR pszSupportHost, SHORT nSupportPort) |
| Set host name (address) and port number of BugTrap Server. This server can automatically gather bug reports for the application. | |
| BUGTRAP_API void APIENTRY | BT_SetSupportURL (LPCTSTR pszSupportURL) |
| Set HTTP address of product support site. | |
| BUGTRAP_API void APIENTRY | BT_SetUserMessage (LPCTSTR pszUserMessage) |
| Set user defined message. This message may be printed to a log file. | |
| BUGTRAP_API void APIENTRY | BT_SetUserMessageFromCode (DWORD dwErrorCode) |
| Set user defined message. This message may be printed to a log file. | |
| BUGTRAP_API void APIENTRY | BT_UninstallSehFilter (void) |
Define Documentation
| #define BT_DO_NOT_USE_DEFAULT_NAMESPACES |
| #define BUGTRAP_API __declspec(dllimport) |
Generated on Sun Dec 21 21:40:08 2008 for BugTrap by
1.5.7.1