DatabaseProvider.TestConnection Method

Tests a connection string for a database provider.

Namespace:  Microsoft.Web.Management.DatabaseManager
Assembly:  Microsoft.Web.Management.DatabaseManager (in Microsoft.Web.Management.DatabaseManager.dll)

Syntax

'Declaration
Public MustOverride Sub TestConnection ( _
    connectionString As String _
)
'Usage
Dim instance As DatabaseProvider
Dim connectionString As String

instance.TestConnection(connectionString)

public abstract void TestConnection(
    string connectionString
)

public:
virtual void TestConnection(
    String^ connectionString
) abstract

public abstract function TestConnection(
    connectionString : String
)

Parameters

• connectionString
  Type: System.String
  The connection string to test.

Remarks

Your provider must implement the TestConnection method in order to test the database connection for your provider.

Examples

The following code sample illustrates an example TestConnection method that opens and closes a database that will test the connection.

    Public Overrides Sub TestConnection(ByVal connectionString As String)

        Dim connection As OleDbConnection = New OleDbConnection(connectionString)
        connection.Open()
        connection.Close()

    End Sub

        public override void TestConnection(
            string connectionString )
        {
            using (OleDbConnection connection = new OleDbConnection(connectionString))
            {
                connection.Open();
                connection.Close();
            }
        }

Permissions

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

DatabaseProvider Class

Microsoft.Web.Management.DatabaseManager Namespace