SqlConnectionStringBuilder.ContainsKey メソッド

.NET Framework クラス ライブラリ リファレンス

SqlConnectionStringBuilder.ContainsKey メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Data.SqlClient
アセンブリ: System.Data (system.data.dll 内)
構文

Visual Basic (宣言)

Public Overrides Function
 ContainsKey ( _
    keyword As String _
) As Boolean

Visual Basic (使用法)

Dim instance As SqlConnectionStringBuilder
Dim keyword As String
Dim returnValue As Boolean

returnValue = instance.ContainsKey(keyword)

C#

public override bool ContainsKey (
    string keyword
)

C++

public:
virtual bool ContainsKey (
    String^ keyword
) override

J#

public boolean ContainsKey (
    String keyword
)

JScript

public override function ContainsKey (
    keyword : String
) : boolean

パラメータ

keyword

SqlConnectionStringBuilder 内で検索されるキー。

戻り値
指定したキーを持つ要素が SqlConnectionStringBuilder に格納されている場合は true。それ以外の場合は false。

例外

例外の種類	条件
ArgumentNullException	keyword が null (Visual Basic の場合は Nothing) です。

解説

SqlConnectionStringBuilder は、キー/値ペアから成る固定サイズのコレクションを保持するため、ContainsKey メソッドで判断されるのは、特定のキー名が有効であるかどうかだけです。

使用例

次の例では、SqlConnectionStringBuilder のインスタンスを作成し、いくつかのプロパティを設定した後、各キーがオブジェクト内に存在するかどうかを、ContainsKey メソッドを使用して確認しています。

Visual Basic

Imports System.Data.SqlClient

Module Module1
    Sub Main()
        Dim builder As _
         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()
    End Sub

    Private Function GetConnectionString()
 As String
        ' 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"
    End Function
End Module

C#

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";
    }
}

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

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

プラットフォーム

Windows 98, Windows 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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SqlConnectionStringBuilder クラス
SqlConnectionStringBuilder メンバ
System.Data.SqlClient 名前空間
その他の技術情報
接続文字列の使用