DbConnectionStringBuilder.ConnectionString プロパティ

定義

DbConnectionStringBuilder に関連付けられた接続文字列を取得または設定します。

public:
 property System::String ^ ConnectionString { System::String ^ get(); void set(System::String ^ value); };
public string ConnectionString { get; set; }
member this.ConnectionString : string with get, set
Public Property ConnectionString As String

プロパティ値

String

DbConnectionStringBuilder 内に含まれるキーと値のペアから作成された、現在の接続文字列。 既定値は空の文字列です。

例外

無効な接続文字列引数が指定されています。

次の例は、プロパティの考えられる動作を ConnectionString 示しています。 この例では、次の処理を実行します。

  • キーと値のペアを一度に 1 つずつ空 DbConnectionStringBuilderに追加して、接続文字列を作成します。

  • インスタンスのプロパティに完全な接続文字列をConnectionStringDbConnectionStringBuilder割り当て、文字列内の 1 つのキーと値のペアを変更します。

  • 任意のキーと値のペア ConnectionString のセットをプロパティに割り当て (接続文字列のようにリモートで何もしない文字列)、値の 1 つを変更します。

  • 無効な接続文字列をプロパティに ConnectionString 割り当て、スローされる例外を示します。

注意

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

static void Main()
{
    // Create a new DbConnctionStringBuilder, and add items
    // to the internal collection of key/value pairs.
    DbConnectionStringBuilder builder = new
        DbConnectionStringBuilder();
    builder.Add("Data Source", @"c:\MyData\MyDb.mdb");
    builder.Add("Provider", "Microsoft.Jet.Oledb.4.0");
    builder.Add("Jet OLEDB:Database Password", "********");
    builder.Add("Jet OLEDB:System Database",
        @"c:\MyData\Workgroup.mdb");

    // Set up row-level locking.
    builder.Add("Jet OLEDB:Database Locking Mode", 1);
    // Display the contents of the connection string, which
    // will now contain all the key/value pairs delimited with
    // semicolons.
    Console.WriteLine(builder.ConnectionString);
    Console.WriteLine();
    // Clear the DbConnectionStringBuilder, and assign a complete
    // connection string to it, to demonstrate how
    // the class parses connection strings.
    builder.Clear();
    builder.ConnectionString =
        "Data Source=(local);Initial Catalog=AdventureWorks;"
        + "Integrated Security=SSPI";
    // The DbConnectionStringBuilder class has parsed the contents,
    // so you can work with any individual key/value pair.
    builder["Data Source"] = ".";
    Console.WriteLine(builder.ConnectionString);
    Console.WriteLine();
    // Because the DbConnectionStringBuilder class doesn't
    // validate its key/value pairs, you can use this class
    // to store any semicolon-delimited list. The following
    // snippet places an arbitrary string into the ConnectionString
    // property, changes one of the values, and then displays the
    // resulting string.
    builder.Clear();
    builder.ConnectionString =
        "Value1=10;Value2=20;Value3=30;Value4=40";
    builder["Value2"] = 25;
    Console.WriteLine(builder.ConnectionString);
    Console.WriteLine();

    builder.Clear();
    try
    {
        // Assigning an invalid connection string
        // throws an ArgumentException.
        builder.ConnectionString = "xxx";
    }
    catch (ArgumentException)
    {
        Console.WriteLine("Invalid connection string.");
    }

    Console.WriteLine();
    Console.WriteLine("Press Enter to finish.");
    Console.ReadLine();
}
Sub Main()
    ' Create a new DbConnctionStringBuilder, and add items
    ' to the internal collection of key/value pairs.
    Dim builder As New DbConnectionStringBuilder()
    builder.Add("Data Source", "c:\MyData\MyDb.mdb")
    builder.Add("Provider", "Microsoft.Jet.Oledb.4.0")
    builder.Add("Jet OLEDB:Database Password", "*******")
    builder.Add("Jet OLEDB:System Database", _
        "c:\MyData\Workgroup.mdb")
    ' Set up row-level locking.
    builder.Add("Jet OLEDB:Database Locking Mode", 1)

    ' Display the contents of the connection string, which
    ' will now contain all the key/value pairs delimited with
    ' semicolons.
    Console.WriteLine(builder.ConnectionString)
    Console.WriteLine()

    ' Clear the DbConnectionStringBuilder, and assign a complete
    ' connection string to it, to demonstrate how
    ' the class parses connection strings.
    builder.Clear()
    builder.ConnectionString = _
        "Data Source=(local);Initial Catalog=AdventureWorks;" & _
        "Integrated Security=SSPI"

    ' The DbConnectionStringBuilder class has parsed the contents, 
    ' so you can work with any individual key/value pair.
    builder("Data Source") = "."
    Console.WriteLine(builder.ConnectionString)
    Console.WriteLine()

    ' Because the DbConnectionStringBuilder class doesn't 
    ' validate its key/value pairs, you can use this class
    ' to store any semicolon-delimited list. The following
    ' snippet places an arbitrary string into the ConnectionString
    ' property, changes one of the values, and then displays the
    ' resulting string.
    builder.Clear()
    builder.ConnectionString = _
        "Value1=10;Value2=20;Value3=30;Value4=40"
    builder("Value2") = 25
    Console.WriteLine(builder.ConnectionString)
    Console.WriteLine()

    builder.Clear()
    Try
        ' Assigning an invalid connection string
        ' throws an ArgumentException.
        builder.ConnectionString = "xxx"

    Catch ex As ArgumentException
        Console.WriteLine("Invalid connection string.")
    End Try

    Console.WriteLine()
    Console.WriteLine("Press Enter to finish.")
    Console.ReadLine()
End Sub

注釈

このプロパティは、によって管理されるコレクション内に格納されているキーと値のペアのセミコロン区切りのリストを DbConnectionStringBuilder返します。 各ペアには、等号で区切られたキーと値が含まれています。 次の例は、一般的な接続文字列を示しています。

"Persist Security Info=False;Integrated Security=SSPI;Initial Catalog=AdventureWorks;Data Source=(local)"

データ プロバイダーでは、接続文字列プロパティごとに特定のキーと値が必要になる場合があります。 、これらの値は個別に文書化されます。 このクラスは DbConnectionStringBuilder 、接続文字列に関連付けられているキーと値のペアを検証しませんが、それを継承するクラスは可能です。

クラスのプロパティは ConnectionString 、通常、等号で区切られたキーと値の DbConnectionStringBuilder ペアのセミコロン区切りのリストを作成および解析するためのメカニズムとして機能します。 接続文字列に固有の検証やその他のサポートは提供されません。 コレクションに項目を DbConnectionStringBuilder 追加すると、プロパティに ConnectionString 変更が反映されます。 プロパティに値を ConnectionString 割り当てると、 DbConnectionStringBuilder セミコロンと等号区切り記号を使用して値の解析が試行されます。

適用対象

こちらもご覧ください