SqlConnectionStringBuilder.ContainsKey(String) メソッド

定義

名前空間:

Microsoft.Data.SqlClient

アセンブリ:

Microsoft.Data.SqlClient.dll

パッケージ:

Microsoft.Data.SqlClient v5.2.0

SqlConnectionStringBuilder に特定のキーが格納されているかどうかを判断します。

public:
 override bool ContainsKey(System::String ^ keyword);

public override bool ContainsKey (string keyword);

override this.ContainsKey : string -> bool

Public Overrides Function ContainsKey (keyword As String) As Boolean

パラメーター

keyword

String

SqlConnectionStringBuilder 内で検索されるキー。

戻り値

Boolean

指定されたキーを持つ要素が SqlConnectionStringBuilder に含まれている場合は true、それ以外の場合は false。

例外

ArgumentNullException

keyword が null (Visual Basic の場合は Nothing) です。

例

次の例では、インスタンスを SqlConnectionStringBuilder 作成し、そのプロパティの一部を設定してから、 ContainsKey メソッドを呼び出して、オブジェクト内にさまざまなキーが存在するかどうかを判断しようとします。

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

この例では、次の出力がコンソール ウィンドウに表示されます。

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

注釈

SqlConnectionStringBuilder には、キー/値ペアの固定サイズ コレクションが含まれているため、ContainsKey メソッドで判断されるのは、特定のキー名が有効かどうかという点のみです。