C# Class GSF.ErrorManagement.ErrorLogger

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

Afficher le fichier Open project: GridProtectionAlliance/gsf Class Usage Examples

Private Properties

Свойство	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

Méthodes publiques

Méthode	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.

Méthodes protégées

Méthode	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

Méthode	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 méthode

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.
Résultat	void

ErrorLogger() public méthode

Initializes a new instance of the ErrorLogger class.

public ErrorLogger ( ) : System
Résultat	System

ErrorLogger() public méthode

Initializes a new instance of the ErrorLogger class.

public ErrorLogger ( IContainer container ) : System
container	IContainer	object that contains the .
Résultat	System

ExceptionToDatabase() protected méthode

Logs encountered Exception to the database.

protected ExceptionToDatabase ( Exception exception ) : void
exception	System.Exception	that was encountered.
Résultat	void

ExceptionToEmail() protected méthode

Logs encountered Exception to an e-mail message.

protected ExceptionToEmail ( Exception exception ) : void
exception	System.Exception	that was encountered.
Résultat	void

ExceptionToEventLog() protected méthode

Logs encountered Exception to the EventLog.

protected ExceptionToEventLog ( Exception exception ) : void
exception	System.Exception	that was encountered.
Résultat	void

ExceptionToFile() protected méthode

Logs encountered Exception to the ErrorLog.

protected ExceptionToFile ( Exception exception ) : void
exception	System.Exception	that was encountered.
Résultat	void

ExceptionToUI() protected méthode

Logs encountered Exception to the application UI.

protected ExceptionToUI ( Exception exception ) : void
exception	System.Exception	that was encountered.
Résultat	void

ExceptionToWebPage() protected méthode

Shows Exception information in a Web Site.

protected ExceptionToWebPage ( ) : void
Résultat	void

ExceptionToWindowsCui() protected méthode

Shows Exception information in a Console Application.

protected ExceptionToWindowsCui ( ) : void
Résultat	void

ExceptionToWindowsGui() protected méthode

Shows Exception information in a Windows Application.

protected ExceptionToWindowsGui ( ) : void
Résultat	void

GetEmailAttachments() protected méthode

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

protected GetEmailAttachments ( ) : string
Résultat	string

GetExceptionInfo() public static méthode

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.
Résultat	string

GetExtendedMoreInfoText() protected méthode

Allows other loggers to extend "more info text".

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

GetMoreInfoText() protected méthode

Default Delegate for MoreInfoTextMethod.

protected GetMoreInfoText ( ) : string
Résultat	string

Initialize() public méthode

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
Résultat	void

LoadSettings() public méthode

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
Résultat	void

Log() public méthode

Logs information about the encountered Exception.

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

Log() public méthode

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.
Résultat	void

OnLoggingException() protected méthode

Raises the LoggingException event.

protected OnLoggingException ( Exception exception ) : void
exception	System.Exception	to send to event.
Résultat	void

Register() protected méthode

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

protected Register ( ) : bool
Résultat	bool

SaveSettings() public méthode

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
Résultat	void

Unregister() protected méthode

Unregister the ErrorLogger object from handling unhandled Exception.

protected Unregister ( ) : bool
Résultat	bool