DbConnectionStringBuilder.ContainsKey Method (String)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Determines whether the DbConnectionStringBuilder contains a specific key.

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

public virtual bool ContainsKey(
	string keyword
)

Parameters

keyword
Type: System.String

The key to locate in the DbConnectionStringBuilder.

Return Value

Type: System.Boolean

true if the DbConnectionStringBuilder contains an entry with the specified key; otherwise false.

Exception Condition
ArgumentNullException

keyword is a null reference (Nothing in Visual Basic).

static void Main()
{
    DbConnectionStringBuilder builder = new DbConnectionStringBuilder();
    builder.Add("Provider", "Provider=Microsoft.Jet.OLEDB.4.0");
    builder.Add("Data Source", "C:\\ThisExcelWorkbook.xls");
    builder.Add("Extended Properties", "Excel 8.0;HDR=Yes;IMEX=1");

    // Displays the values in the DbConnectionStringBuilder.
    Console.WriteLine("Contents of the DbConnectionStringBuilder:");
    Console.WriteLine(builder.ConnectionString);

    // Searches for a key.
    if (builder.ContainsKey("Data Source"))
    {
        Console.WriteLine("The collection contains the key \"Data Source\".");
    }
    else
    {
        Console.WriteLine("The collection does not contain the key \"Data Source\".");
    }
    Console.ReadLine();
}

This code produces the following output:

Contents of the DbConnectionStringBuilder:
provider="Provider=Microsoft.Jet.OLEDB.4.0";data 
source=C:\MyExcel.xls;extended
properties="Excel 8.0;HDR=Yes;IMEX=1"
The collection contains the key "Data Source".

Universal Windows Platform
Available since 10
.NET Framework
Available since 2.0
Return to top
Show: