DbConnectionStringBuilder.ConnectionString プロパティ

定義

DbConnectionStringBuilder に関連付けられた接続文字列を取得または設定します。Gets or sets the connection string associated with the 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 内に含まれるキーと値のペアから作成された、現在の接続文字列。The current connection string, created from the key/value pairs that are contained within the DbConnectionStringBuilder. 既定値は空の文字列です。The default value is an empty string.

例外

無効な接続文字列引数が指定されています。An invalid connection string argument has been supplied.

次の例は、プロパティの可能な動作を示して ConnectionString います。The following example demonstrates possible behaviors of the ConnectionString property. この例では、次の処理を実行します。The example:

  • キーと値のペアを一度に1つずつ空のに追加することによって、接続文字列を作成し DbConnectionStringBuilder ます。Creates a connection string by adding key/value pairs, one at a time, to an empty DbConnectionStringBuilder.

  • 完全な接続文字列を ConnectionString インスタンスのプロパティに割り当て、 DbConnectionStringBuilder 文字列内の1つのキーと値のペアを変更します。Assigns a complete connection string to the ConnectionString property of the DbConnectionStringBuilder instance, and modifies a single key/value pair within the string.

  • 任意のキー/値ペアのセットを ConnectionString プロパティ (つまり、接続文字列としてリモートではない文字列) に割り当て、値の1つを変更します。Assigns an arbitrary set of key/value pairs to the ConnectionString property (that is, a string that is not anything remotely like a connection string), and modifies one of the values.

  • プロパティに無効な接続文字列を割り当てて ConnectionString 、スローされた例外を示します。Assigns an invalid connection string to the ConnectionString property, demonstrating the exception that is thrown.

注意

この例には、DbConnectionStringBuilder による接続文字列の操作方法を示すために、パスワードが含まれています。This example includes a password to demonstrate how DbConnectionStringBuilder works with connection strings. 実際のアプリケーションでは、Windows 認証を使用することをお勧めします。In your applications, we recommend that you use Windows Authentication. パスワードを使用する必要がある場合も、ハードコードされたパスワードをアプリケーションに含めないでください。If you must use a password, do not include a hard-coded password in your application.

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 ます。This property returns a semicolon-delimited list of key/value pairs stored within the collection maintained by the DbConnectionStringBuilder. 各ペアには、等号で区切られたキーと値が含まれています。Each pair contains the key and value, separated by an equal sign. 一般的な接続文字列の例を次に示します。The following example illustrates a typical connection string.

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

データプロバイダーは、接続文字列プロパティごとに特定のキーと値を必要とする場合があります。Data providers may expect specific keys and values for each connection string property. これらの値は個別に記載されています。, These values are documented individually. クラスは、その DbConnectionStringBuilder 接続文字列に関連付けられているキーと値のペアを検証しませんが、それを継承するクラスは使用できます。The DbConnectionStringBuilder class does not validate the key/value pairs associated with its connection string, although classes that inherit from it can.

ConnectionStringクラスのプロパティは、 DbConnectionStringBuilder 通常、等号で区切られたキー/値ペアのセミコロン区切りのリストを作成および解析する機構として機能します。The ConnectionString property of the DbConnectionStringBuilder class acts generally as a mechanism for creating and parsing semicolon-delimited lists of key/value pairs separated with equal signs. 接続文字列に固有の検証やその他のサポートは提供されません。It provides no validation or other support specific to connection strings. コレクションに項目を追加すると、 DbConnectionStringBuilder ConnectionString プロパティに変更が反映されます。If you add items to the DbConnectionStringBuilder collection, the ConnectionString property will reflect the changes. プロパティに値を割り当てた場合、は ConnectionString DbConnectionStringBuilder セミコロンと等号記号を使用して値を解析しようとします。If you assign a value to the ConnectionString property, the DbConnectionStringBuilder will try to parse the value, using the semicolon and equal-sign delimiters.

適用対象