BugSplat.CrashReporter Class Reference

Main class used to enable Online Application Crash Reporting More...

Public Member Functions
delegate void	Callback (Exception e)
	The event handler delegate for unhandled exceptions. More...

Static Public Member Functions
static void	Init (string Database, string App, string Version, string BsSndRptPath)
	Initialize BugSplat exception handling More...
static void	createReport (Exception e)
	Create a crash report. More...
static void	AppDomainUnhandledExceptionHandler (Object sender, UnhandledExceptionEventArgs args)
	Handler for main thread exceptions, see AppDomain.UnhandledException. More...
static void	ApplicationThreadException (object sender, ThreadExceptionEventArgs t)
	Handler for WinForms UI thread exceptions, see Application.ThreadException. More...

Properties
static string	Version [get, set]
	Version string. More...
static string	AppIdentifier [get, set]
	Application identifier string. More...
static string	User [get, set]
	Default user string. Useful for quiet-mode applications that don't prompt for user/email/description at crash time. More...
static string	Email [get, set]
	Default user email string. Useful for quiet-mode applications that don't prompt for user/email/description at crash time. More...
static string	UserDescription [get, set]
	Default user description. Useful for quiet-mode applications that don't prompt for user/email/description at crash time. More...
static string	ResourceDllPath [get, set]
	Use to set full path for BsSndRpt's resource DLL (allows dialog customizations, e.g. language); default is ./BugSplatRc.dll. More...
static bool	ExitOnError [get, set]
	Change the exit behavior at runtime. More...
static bool	QuietMode [get, set]
	Control appearance of dialog prompting for permission to send a crash report. More...
static bool	LegacyMode [get, set]
	In legacy mode, an XML exception callstack is generated on the client for the currently executing thread only. PDB files must be present in the directory containing the application executable. No minidump is created. Default value is false. More...
static List< string >	AdditionalFiles [get, set]
	Additional files to be sent as part of the crash report. More...

Events
static Callback	exceptionHandled
	The event an application can register for allowing application code to run during an unhandled exception. More...

Detailed Description

Main class used to enable Online Application Crash Reporting

Member Function Documentation

AppDomainUnhandledExceptionHandler()

static void BugSplat.CrashReporter.AppDomainUnhandledExceptionHandler ( Object  sender, UnhandledExceptionEventArgs  args  )

static

Handler for main thread exceptions, see AppDomain.UnhandledException.

ApplicationThreadException()

static void BugSplat.CrashReporter.ApplicationThreadException ( object  sender, ThreadExceptionEventArgs  t  )

static

Handler for WinForms UI thread exceptions, see Application.ThreadException.

Callback()

delegate void BugSplat.CrashReporter.Callback

(

Exception

e

)

The event handler delegate for unhandled exceptions.

createReport()

static void BugSplat.CrashReporter.createReport ( Exception  e )

static

Create a crash report.

Init()

static void BugSplat.CrashReporter.Init ( string  Database, string  App, string  Version, string  BsSndRptPath  )

static

Initialize BugSplat exception handling

Parameters

Database	Database name
App	Application name
Version	Version identifier
BsSndRptPath	Path to BsSndRpt.exe, the crash report sender distributed with BugSplat-enabled applications.

Throws an exception if BsSndRpt.exe cannot be found in the specified location.

Property Documentation

AdditionalFiles

List<string> BugSplat.CrashReporter.AdditionalFiles

staticgetset

Additional files to be sent as part of the crash report.

AppIdentifier

string BugSplat.CrashReporter.AppIdentifier

staticgetset

Application identifier string.

Email

string BugSplat.CrashReporter.Email

staticgetset

Default user email string. Useful for quiet-mode applications that don't prompt for user/email/description at crash time.

ExitOnError

bool BugSplat.CrashReporter.ExitOnError

staticgetset

Change the exit behavior at runtime.

LegacyMode

bool BugSplat.CrashReporter.LegacyMode

staticgetset

In legacy mode, an XML exception callstack is generated on the client for the currently executing thread only. PDB files must be present in the directory containing the application executable. No minidump is created. Default value is false.

QuietMode

bool BugSplat.CrashReporter.QuietMode

staticgetset

Control appearance of dialog prompting for permission to send a crash report.

ResourceDllPath

string BugSplat.CrashReporter.ResourceDllPath

staticgetset

Use to set full path for BsSndRpt's resource DLL (allows dialog customizations, e.g. language); default is ./BugSplatRc.dll.

User

string BugSplat.CrashReporter.User

staticgetset

Default user string. Useful for quiet-mode applications that don't prompt for user/email/description at crash time.

UserDescription

string BugSplat.CrashReporter.UserDescription

staticgetset

Default user description. Useful for quiet-mode applications that don't prompt for user/email/description at crash time.

Version

string BugSplat.CrashReporter.Version

staticgetset

Version string.

Event Documentation

exceptionHandled

Callback BugSplat.CrashReporter.exceptionHandled

static

The event an application can register for allowing application code to run during an unhandled exception.

---

The documentation for this class was generated from the following file:

• BugSplatDotNet.cs