SqlConnectionStringBuilder コンストラクター

定義

名前空間:

Microsoft.Data.SqlClient

アセンブリ:

Microsoft.Data.SqlClient.dll

パッケージ:

Microsoft.Data.SqlClient v5.2.0

オーバーロード

SqlConnectionStringBuilder()	SqlConnectionStringBuilder クラスの新しいインスタンスを初期化します。
SqlConnectionStringBuilder(String)	SqlConnectionStringBuilder クラスの新しいインスタンスを初期化します。 指定された接続文字列によって、インスタンスの内部的な接続情報のデータが提供されます。

SqlConnectionStringBuilder()

SqlConnectionStringBuilder クラスの新しいインスタンスを初期化します。

public:
 SqlConnectionStringBuilder();

public SqlConnectionStringBuilder ();

Public Sub New ()

SqlConnectionStringBuilder(String)

SqlConnectionStringBuilder クラスの新しいインスタンスを初期化します。 指定された接続文字列によって、インスタンスの内部的な接続情報のデータが提供されます。

public:
 SqlConnectionStringBuilder(System::String ^ connectionString);

public SqlConnectionStringBuilder (string connectionString);

new Microsoft.Data.SqlClient.SqlConnectionStringBuilder : string -> Microsoft.Data.SqlClient.SqlConnectionStringBuilder

Public Sub New (connectionString As String)

パラメーター

connectionString

String

オブジェクトの内部的な接続情報のベース。 この情報が解析され、名前/値のペアが生成されます。 無効なキー名が指定されると、KeyNotFoundException が発生します。

例外

KeyNotFoundException

接続文字列内のキー名が無効です。

FormatException

接続文字列に無効な値が含まれています (具体的には、ブール値または数値が要求されているにもかかわらず適切な値が提供されませんでした)。

ArgumentException

指定された connectionString が無効です。

例

次の例では、単純な SQL Server 接続文字列を SqlConnectionStringBuilder オブジェクトのコンストラクターに渡し、オブジェクト内のすべてのキー/値ペアを反復処理します。 コレクションによって提供されるのは、各項目の既定値です。 また、SqlConnectionStringBuilder クラスでは、既知の名前と矛盾しないように、既知のキーに対するシノニムの変換も行われます。

注意

この例には、SqlConnectionStringBuilder による接続文字列の操作方法を示すために、パスワードが含まれています。 実際のアプリケーションでは、Windows 認証を使用することをお勧めします。 パスワードを使用する必要がある場合も、ハードコードされたパスワードをアプリケーションに含めないでください。

using Microsoft.Data.SqlClient;

class Program
{
    static void Main()
    {
        try
        {
            string connectString =
                "Server=(local);Database=AdventureWorks;UID=ab;Pwd= a!Pass@@";
            Console.WriteLine("Original: " + connectString);
            SqlConnectionStringBuilder builder =
                new SqlConnectionStringBuilder(connectString);
            Console.WriteLine("Modified: " + builder.ConnectionString);
            foreach (string key in builder.Keys)
                Console.WriteLine(key + "=" + builder[key].ToString());
            Console.WriteLine("Press any key to finish.");
            Console.ReadLine();

        }
        catch (System.Collections.Generic.KeyNotFoundException ex)
        {
            Console.WriteLine("KeyNotFoundException: " + ex.Message);
        }
        catch (System.FormatException ex)
        {
            Console.WriteLine("Format exception: " + ex.Message);
        }
    }
}

注釈

SqlConnectionStringBuilder クラスは、あらかじめ決められたキー/値ペアの内部コレクションを提供します。 有効な接続文字列値のごく一部のみをコンストラクターに渡した場合も、このオブジェクトでは常に、キー/値の各ペアの既定値が提供されます。 オブジェクトの ConnectionString プロパティが取得されると、文字列には、値がアイテムの既定値ではないキーと値のペアのみが含まれます。