FilterConnectionErrorMessage Method

Filter method giving inheritors the opportunity to adjust the text used in a connection error message.

Syntax

Visual Basic

'Declaration
 
Protected Overridable Function FilterConnectionErrorMessage( _
   ByVal originalErrorMessage As String, _
   ByVal suggestedErrorMessage As String, _
   ByVal notUsed As IDictionary _
) As String

C#

protected virtual string FilterConnectionErrorMessage( 
   string originalErrorMessage,
   string suggestedErrorMessage,
   IDictionary notUsed
)

Parameters

originalErrorMessage

The original message text, which may be localized, from the ADO.NET exception thrown when the connection has failed.

suggestedErrorMessage

The error message the Infragistics WebSchedule data providers recommend.

notUsed

Reserved for future use.

Return Value

The error message text associated with the no connection error.

Remarks

Inheritors of concrete WebScheduleDBProvider subclasses may support databases other than Microsoft Access and SQL Server, therefore the suggestedErrorMessage may not fit your subclass because it makes implementation specific references in the guidance it offers when a connection fails.

Another reason to override this method is to remove sensitive information that may be contained in a connection failure error message, such as user identity information and server file path information.

This method can also be used for diagnostic event logging, based on the content of the originalErrorMessage argument.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2