DbConnectionStringBuilder.ConnectionString Свойство

Определение

Пространство имен:

System.Data.Common

Сборки:

netstandard.dll, System.Data.Common.dll

Исходный код:

DbConnectionStringBuilder.cs

Возвращает или задает строку подключения, связанную с .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. Значение по умолчанию: пустая строка.

Исключения

ArgumentException

Указан недопустимый аргумент строки подключения.

Примеры

В следующем примере показано возможное поведение ConnectionString свойства. Пример.

• Создает строку подключения путем добавления пар "ключ-значение", по одному за раз в пустое DbConnectionStringBuilder.

• Назначает полную строку ConnectionString подключения свойству экземпляра DbConnectionStringBuilder и изменяет одну пару "ключ-значение" в строке.

• Присваивает произвольный набор пар ConnectionString "ключ-значение" свойству (т. е. строка, которая не является удаленной строкой подключения) и изменяет одно из значений.

• Присваивает свойству недопустимую строку 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: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.");
    }
}

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: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 попытается проанализировать значение, используя разделители с запятой и знаками равенства.

См. также раздел

• Строки подключения в ADO.NET
• Общие сведения об ADO.NET