Export (0) Print
Expand All

SqlConnectionStringBuilder.ContainsKey Method

Determines whether the SqlConnectionStringBuilder contains a specific key.

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

public override bool ContainsKey(
	string keyword
)

Parameters

keyword
Type: System.String

The key to locate in the SqlConnectionStringBuilder.

Return Value

Type: System.Boolean
true if the SqlConnectionStringBuilder contains an element that has the specified key; otherwise, false.

ExceptionCondition
ArgumentNullException

keyword is null (Nothing in Visual Basic)

Because the SqlConnectionStringBuilder contains a fixed-size collection of key/value pairs, the ContainsKey method determines only if a particular key name is valid.

The following example creates a SqlConnectionStringBuilder instance, sets some of its properties, and then tries to determine whether various keys exist within the object by calling the ContainsKey method.

using System.Data.SqlClient;

class Program
{
    static void Main()
    {
        SqlConnectionStringBuilder builder =
            new SqlConnectionStringBuilder(GetConnectionString());
        Console.WriteLine("Connection string = " + builder.ConnectionString);

        // Keys you have provided return true.
        Console.WriteLine(builder.ContainsKey("Server"));

        // Comparison is case insensitive, and synonyms 
        // are automatically converted to their "well-known" 
        // names.
        Console.WriteLine(builder.ContainsKey("Database"));

        // Keys that are valid but have not been set return true.
        Console.WriteLine(builder.ContainsKey("Max Pool Size"));

        // Keys that do not exist return false.
        Console.WriteLine(builder.ContainsKey("MyKey"));

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

    }

    private static string GetConnectionString()
    {
        // To avoid storing the connection string in your code, 
        // you can retrieve it from a configuration file.  
        return "Server=(local);Integrated Security=SSPI;" +
            "Initial Catalog=AdventureWorks";
    }
}

The example displays the following output in the console window:

Connection string = Data Source=(local);Initial Catalog=AdventureWorks;Integrated Security=True
True
True
True
False

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft