C# Class GSF.ErrorManagement.ErrorLogger

Inheritance: System.ComponentModel.Component, ISupportLifecycle, ISupportInitialize, IProvideStatus, IPersistSettings

Exibir arquivo Open project: GridProtectionAlliance/gsf Class Usage Examples

Private Properties

Property	Type	Description
BeginInit	void
EndInit	void
GetActionText	string
GetApplicationInfo	string
GetErrorText	string
GetExceptionGeneralInfo	string
GetExceptionStackTrace	string
GetScopeText	string
GetSystemInfo	string
ProcessExceptionsToDatabase	void
UnhandledException	void
m_databaseErrorQueue_ProcessException	void
m_tableSizeCurtailmentTimer_Elapsed	void

Public Methods

Method	Description
ErrorLogger ( ) : System	Initializes a new instance of the ErrorLogger class.
ErrorLogger ( IContainer container ) : System	Initializes a new instance of the ErrorLogger class.
GetExceptionInfo ( Exception ex, bool includeUserInfo ) : string	Gets information about an Exception complete with system and application information.
Initialize ( ) : void	Initializes the ErrorLogger object. Initialize() is to be called by user-code directly only if the ErrorLogger object is not consumed through the designer surface of the IDE.
LoadSettings ( ) : void	Loads saved settings for the ErrorLogger object from the config file if the PersistSettings property is set to true.
Log ( Exception exception ) : void	Logs information about the encountered Exception.
Log ( Exception exception, bool exitApplication ) : void	Logs information about the encountered Exception.
SaveSettings ( ) : void	Saves settings for the ErrorLogger object to the config file if the PersistSettings property is set to true.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Releases the unmanaged resources used by the ErrorLogger object and optionally releases the managed resources.
ExceptionToDatabase ( Exception exception ) : void	Logs encountered Exception to the database.
ExceptionToEmail ( Exception exception ) : void	Logs encountered Exception to an e-mail message.
ExceptionToEventLog ( Exception exception ) : void	Logs encountered Exception to the EventLog.
ExceptionToFile ( Exception exception ) : void	Logs encountered Exception to the ErrorLog.
ExceptionToUI ( Exception exception ) : void	Logs encountered Exception to the application UI.
ExceptionToWebPage ( ) : void	Shows Exception information in a Web Site.
ExceptionToWindowsCui ( ) : void	Shows Exception information in a Console Application.
ExceptionToWindowsGui ( ) : void	Shows Exception information in a Windows Application.
GetEmailAttachments ( ) : string	Gets or sets the comma-separated or semicolon-separated list of file names to be attached to the Mail message.
GetExtendedMoreInfoText ( string bullet ) : string	Allows other loggers to extend "more info text".
GetMoreInfoText ( ) : string	Default Delegate for MoreInfoTextMethod.
OnLoggingException ( Exception exception ) : void	Raises the LoggingException event.
Register ( ) : bool	Registers the ErrorLogger object to handle unhandled Exception if the HandleUnhandledException property is set to true.
Unregister ( ) : bool	Unregister the ErrorLogger object from handling unhandled Exception.

Private Methods

Method	Description
BeginInit ( ) : void
EndInit ( ) : void
GetActionText ( ) : string	Default Delegate for ActionTextMethod.
GetApplicationInfo ( ) : string	Gets information about the current application.
GetErrorText ( ) : string	Default Delegate for ErrorTextMethod.
GetExceptionGeneralInfo ( Exception ex ) : string	Gets common information about an Exception.
GetExceptionStackTrace ( Exception ex ) : string	Gets stack trace information about an Exception.
GetScopeText ( ) : string	Default Delegate for ScopeTextMethod.
GetSystemInfo ( bool includeUserInfo ) : string	Gets information about the system where current application is executing.
ProcessExceptionsToDatabase ( Tuple exceptions ) : void
UnhandledException ( object sender, UnhandledExceptionEventArgs e ) : void
m_databaseErrorQueue_ProcessException ( object sender, EventArgs e ) : void
m_tableSizeCurtailmentTimer_Elapsed ( object sender, System e ) : void

Method Details

Dispose() protected method

Releases the unmanaged resources used by the ErrorLogger object and optionally releases the managed resources.

protected Dispose ( bool disposing ) : void
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.
return	void

ErrorLogger() public method

Initializes a new instance of the ErrorLogger class.

public ErrorLogger ( ) : System
return	System

ErrorLogger() public method

Initializes a new instance of the ErrorLogger class.

public ErrorLogger ( IContainer container ) : System
container	IContainer	object that contains the .
return	System

ExceptionToDatabase() protected method

Logs encountered Exception to the database.

protected ExceptionToDatabase ( Exception exception ) : void
exception	System.Exception	that was encountered.
return	void

ExceptionToEmail() protected method

Logs encountered Exception to an e-mail message.

protected ExceptionToEmail ( Exception exception ) : void
exception	System.Exception	that was encountered.
return	void

ExceptionToEventLog() protected method

Logs encountered Exception to the EventLog.

protected ExceptionToEventLog ( Exception exception ) : void
exception	System.Exception	that was encountered.
return	void

ExceptionToFile() protected method

Logs encountered Exception to the ErrorLog.

protected ExceptionToFile ( Exception exception ) : void
exception	System.Exception	that was encountered.
return	void

ExceptionToUI() protected method

Logs encountered Exception to the application UI.

protected ExceptionToUI ( Exception exception ) : void
exception	System.Exception	that was encountered.
return	void

ExceptionToWebPage() protected method

Shows Exception information in a Web Site.

protected ExceptionToWebPage ( ) : void
return	void

ExceptionToWindowsCui() protected method

Shows Exception information in a Console Application.

protected ExceptionToWindowsCui ( ) : void
return	void

ExceptionToWindowsGui() protected method

Shows Exception information in a Windows Application.

protected ExceptionToWindowsGui ( ) : void
return	void

GetEmailAttachments() protected method

Gets or sets the comma-separated or semicolon-separated list of file names to be attached to the Mail message.

protected GetEmailAttachments ( ) : string
return	string

GetExceptionInfo() public static method

Gets information about an Exception complete with system and application information.

public static GetExceptionInfo ( Exception ex, bool includeUserInfo ) : string
ex	System.Exception	whose information is to be retrieved.
includeUserInfo	bool	true if user information is to be include; otherwise false.
return	string

GetExtendedMoreInfoText() protected method

Allows other loggers to extend "more info text".

protected GetExtendedMoreInfoText ( string bullet ) : string
bullet	string	Type of bullet to use for extended info text.
return	string

GetMoreInfoText() protected method

Default Delegate for MoreInfoTextMethod.

protected GetMoreInfoText ( ) : string
return	string

Initialize() public method

Initializes the ErrorLogger object.

Initialize() is to be called by user-code directly only if the ErrorLogger object is not consumed through the designer surface of the IDE.

public Initialize ( ) : void
return	void

LoadSettings() public method

Loads saved settings for the ErrorLogger object from the config file if the PersistSettings property is set to true.

has a value of null or empty string.

public LoadSettings ( ) : void
return	void

Log() public method

Logs information about the encountered Exception.

public Log ( Exception exception ) : void
exception	System.Exception	Encountered whose information is to be logged.
return	void

Log() public method

Logs information about the encountered Exception.

public Log ( Exception exception, bool exitApplication ) : void
exception	System.Exception	Encountered whose information is to be logged.
exitApplication	bool	true to exit the application; otherwise false.
return	void

OnLoggingException() protected method

Raises the LoggingException event.

protected OnLoggingException ( Exception exception ) : void
exception	System.Exception	to send to event.
return	void

Register() protected method

Registers the ErrorLogger object to handle unhandled Exception if the HandleUnhandledException property is set to true.

protected Register ( ) : bool
return	bool

SaveSettings() public method

Saves settings for the ErrorLogger object to the config file if the PersistSettings property is set to true.

has a value of null or empty string.

public SaveSettings ( ) : void
return	void

Unregister() protected method

Unregister the ErrorLogger object from handling unhandled Exception.

protected Unregister ( ) : bool
return	bool