IDataEnvironment.ConfigureConnection Метод

Определение

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

System.ComponentModel.Design.Data

Сборка:

System.Design.dll

Записывает строку подключения в файл конфигурации приложения.

public:
 System::ComponentModel::Design::Data::DesignerDataConnection ^ ConfigureConnection(System::Windows::Forms::IWin32Window ^ owner, System::ComponentModel::Design::Data::DesignerDataConnection ^ connection, System::String ^ name);

public System.ComponentModel.Design.Data.DesignerDataConnection ConfigureConnection(System.Windows.Forms.IWin32Window owner, System.ComponentModel.Design.Data.DesignerDataConnection connection, string name);

abstract member ConfigureConnection : System.Windows.Forms.IWin32Window * System.ComponentModel.Design.Data.DesignerDataConnection * string -> System.ComponentModel.Design.Data.DesignerDataConnection

Public Function ConfigureConnection (owner As IWin32Window, connection As DesignerDataConnection, name As String) As DesignerDataConnection

Параметры

owner

IWin32Window

Родительское окно диалогового окна, если таковое есть.

connection

DesignerDataConnection

Объект DesignerDataConnection , содержащий данные подключения для сохранения.

name

String

Имя новой записи конфигурации подключения.

Возвращаемое значение

DesignerDataConnection

DesignerDataConnection Объект, содержащий сохраненные данные подключения со свойствомName, равным nameсвойству, и свойствуIsConfigured, в котором задано значение true.

Комментарии

Метод ConfigureConnection записывает подключение к файлу конфигурации приложения. Строка подключения и имя поставщика записываются в элемент конфигурации connectionStrings (ASP.NET settings Schema) с именем в соответствии с параметром name . Name Свойство connection параметра игнорируется.

ConfigureConnection Реализации метода должны вызывать следующие исключения.

Исключение	Причина
ArgumentException	Повторяющееся имя существует в файле конфигурации приложения.
FileNotFoundException, UnauthorizedAccessExceptionили другое соответствующее исключение ввода-вывода в файл.	Невозможно обновить файл конфигурации приложения. Реализация ConfigureConnection метода должна вызывать соответствующее исключение.
CheckoutException	Файл конфигурации приложения не может быть извлечен из системы управления версиями.

Рекомендуется использовать API-интерфейсы управления конфигурацией в System.Configuration пространстве имен для чтения и записи файла конфигурации приложения. Класс ConnectionStringsSection будет считывать и записывать элемент конфигурации connectionStrings (ASP.NET Settings Schema).