This documentation is archived and is not being maintained.

SqlConnectionStringBuilder.Clear Method

Clears the contents of the SqlConnectionStringBuilder instance.

Namespace: System.Data.SqlClient
Assembly: System.Data (in system.data.dll)

public override void Clear ()
public void Clear ()
public override function Clear ()
Not applicable.

The Clear method removes all key/value pairs from the SqlConnectionStringBuilder, and resets all corresponding properties. This includes setting the Count property to 0, and setting the ConnectionString property to an empty string.

The following example demonstrates calling the Clear method. This example populates the SqlConnectionStringBuilder with some key/value pairs, and then calls the Clear method and shows the results.

using System.Data.SqlClient;

class Program
{
    static void Main()
    {
        SqlConnectionStringBuilder builder = new SqlConnectionStringBuilder();
        builder.DataSource = "(local)";
        builder.IntegratedSecurity = true;
        builder.InitialCatalog = "AdventureWorks";
        Console.WriteLine("Initial connection string: " + builder.ConnectionString);

        builder.Clear();
        Console.WriteLine("After call to Clear, count = " + builder.Count);
        Console.WriteLine("Cleared connection string: " + builder.ConnectionString);
        Console.WriteLine();

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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0
Show: