IDataEnvironment.ConfigureConnection メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

IDataEnvironment.ConfigureConnection メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

アプリケーションの構成ファイルに接続文字列を書き込みます。

名前空間: System.ComponentModel.Design.Data
アセンブリ: System.Design (system.design.dll 内)
構文

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As IDataEnvironment
Dim owner As IWin32Window
Dim connection As DesignerDataConnection
Dim name As String
Dim returnValue As DesignerDataConnection

returnValue = instance.ConfigureConnection(owner, connection, name)

DesignerDataConnection ConfigureConnection (
    IWin32Window owner,
    DesignerDataConnection connection,
    string name
)

C++

DesignerDataConnection^ ConfigureConnection (
    IWin32Window^ owner, 
    DesignerDataConnection^ connection, 
    String^ name
)

DesignerDataConnection ConfigureConnection (
    IWin32Window owner, 
    DesignerDataConnection connection, 
    String name
)

JScript

function ConfigureConnection (
    owner : IWin32Window, 
    connection : DesignerDataConnection, 
    name : String
) : DesignerDataConnection

パラメータ

owner: ダイアログの親ウィンドウ (存在する場合)。

connection: 保存する接続データを格納する DesignerDataConnection オブジェクト。

name: 新しい接続の構成エントリの名前。

戻り値
Name プロパティを name に設定し、IsConfigured プロパティを true に設定した、保存された接続データを格納する DesignerDataConnection オブジェクト。

解説

ConfigureConnection メソッドは、アプリケーションの構成ファイルに接続を書き込みます。接続文字列とプロバイダ名は、name パラメータに基づいた名前の connectionStrings 要素 (ASP.NET 設定スキーマ) 構成要素に書き込まれます。connection パラメータの Name プロパティは無視されます。

ConfigureConnection メソッドの実装は、次の例外をスローします。

例外	理由
ArgumentException	アプリケーションの構成ファイルに重複する名前が存在します。
FileNotFoundException、UnauthorizedAccessException、などの適切なファイル IO 例外。	アプリケーションの構成ファイルを更新できません。ConfigureConnection メソッドの実装は、適切な例外をスローします。
CheckoutException	アプリケーションの構成ファイルを、ソース管理システムからチェックアウトできません。