SqlConnectionStringBuilder.Clear Method

Definition

Namespace:

Microsoft.Data.SqlClient

Assembly:

Microsoft.Data.SqlClient.dll

Package:

Microsoft.Data.SqlClient v5.2.0

Clears the contents of the SqlConnectionStringBuilder instance.

C#

public override void Clear ();

Examples

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.

C#

using Microsoft.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();
    }
}

Remarks

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.

Applies to