OdbcConnectionStringBuilder.Clear Method

Definition

Namespace:

System.Data.Odbc

Assembly:

System.Data.Odbc.dll

Package:

System.Data.Odbc v9.0.0-rc.2.24473.5

Source:

OdbcConnectionStringbuilder.cs

Clears the contents of the OdbcConnectionStringBuilder instance.

public:
 override void Clear();

public override void Clear ();

override this.Clear : unit -> unit

Public Overrides Sub Clear ()

Examples

using System.Data.Odbc;
class Program
{
    static void Main()
    {
        OdbcConnectionStringBuilder builder = new OdbcConnectionStringBuilder();

        // Call the Add method to explicitly add key/value
        // pairs to the internal collection.
        builder.Driver = "Microsoft Excel Driver (*.xls)";
        builder["Dbq"] = "C:\\Data.xls";
        builder["DriverID"] = "790";
        builder["DefaultDir"] = "C:\\";

        // Dump the contents of the "filled-in" OdbcConnectionStringBuilder
        // to the Console window:
        DumpBuilderContents(builder);

        // Clear current values and reset known keys to their
        // default values.
        builder.Clear();

        // Dump the contents of the newly emptied OdbcConnectionStringBuilder
        // to the console window.
        DumpBuilderContents(builder);

        Console.WriteLine("Press Enter to continue.");
        Console.ReadLine();
    }

    private static void DumpBuilderContents(OdbcConnectionStringBuilder builder)
    {
        Console.WriteLine("=================");
        Console.WriteLine("builder.ConnectionString = " + builder.ConnectionString);
        foreach (string key in builder.Keys)
        {
            Console.WriteLine(key + "=" + builder[key].ToString());
        }
    }
}

Imports System.Data.Odbc    

Module Module1
  Sub Main()
    Dim builder As New OdbcConnectionStringBuilder()

    ' Call the Add method to explicitly add key/value
    ' pairs to the internal collection.
    builder.Driver = "Microsoft Excel Driver (*.xls)"
    builder("Dbq") = "C:\Data.xls"
    builder("DriverID") = "790"
    builder("DefaultDir") = "C:\"

    ' Dump the contents of the "filled-in" OdbcConnectionStringBuilder
    ' to the console window.
    DumpBuilderContents(builder)

    ' Clear current values and reset known keys to their
    ' default values.
    builder.Clear()

    ' Dump the contents of the newly emptied 
    ' OdbcConnectionStringBuilder
    ' to the console window.
    DumpBuilderContents(builder)

    Console.WriteLine("Press Enter to continue.")
    Console.ReadLine()
  End Sub

  Private Sub DumpBuilderContents(ByVal builder As OdbcConnectionStringBuilder)
    Console.WriteLine("=================")
    Console.WriteLine("builder.ConnectionString = " & builder.ConnectionString)
    For Each key As String In builder.Keys
      Console.WriteLine(key & "=" & builder.Item(key).ToString)
    Next
  End Sub
End Module

Remarks

The Clear method removes all key/value pairs from the OdbcConnectionStringBuilder and resets the Driver and Dsn properties to their default values. The Clear method also sets the Count property to 0 and the ConnectionString property to an empty string.

See also

• Connection String Builders
• Connection Strings in ADO.NET