OleDbConnectionStringBuilder クラス
アセンブリ: System.Data (system.data.dll 内)


接続文字列ビルダにより、クラスのプロパティとメソッドを使用して、構文的に正確な接続文字列をプログラムで作成したり、既存の接続文字列を解析および再構築したりできます。接続文字列ビルダは、OLE DB 接続がサポートする既知のキー/値ペアに対応した、厳密に型指定されたプロパティを提供するほか、開発者が他の接続文字列値に対して任意のキー/値ペアを追加することもできます。OleDbConnectionStringBuilder クラスは、ICustomTypeDescriptor インターフェイスを実装します。つまり、クラスと Visual Studio .NET デザイナがデザイン時に連動するということです。Visual Studio .NET のデザイナを使用して厳密に型指定された DataSet および厳密に型指定された接続を作成することにより、厳密に型指定された接続文字列ビルダ クラスによって、その型に関連付けられたプロパティが表示されるほか、既知のキーに共通の値をマップするためのコンバータを使用できるようになります。
接続文字列をアプリケーション内で生成する必要がある場合、OleDbConnectionStringBuilder クラスを使用して、接続文字列を生成および修正できます。また、このクラスを利用することで、アプリケーションの構成ファイルに格納される接続文字列の管理が容易になります。OleDbConnectionStringBuilder によって実行されるチェックは、既知のキー/値ペアに限定されます。したがって、このクラスを使用した場合、無効な接続文字列が生成される場合もあります。既知のキーと、OleDbConnectionStringBuilder クラス内の対応するプロパティ、およびその既定値の一覧を次の表に示します。これらの特定の値以外にも、開発者は任意のキー/値ペアを、OleDbConnectionStringBuilder のインスタンス内に保持されるコレクションに追加できます。
"" | ||
"" | ||
DataSource | "" | |
PersistSecurityInfo | ||
OleDbServices | -13 |
Item プロパティは、安全ではないエントリの挿入が試みられた場合も、適切に処理します。たとえば、次のコードでは、既定の Item プロパティ (C# ではインデクサ) を使用することで、入れ子になったキー/値ペアが適切にエスケープされています。
Dim builder As _ New System.Data.OleDb.OleDbConnectionStringBuilder builder("Provider") = "Microsoft.Jet.OLEDB.4.0" builder("Data Source") = "C:\Sample.mdb" builder("User Id") = "Admin;NewValue=Bad"

次のコンソール アプリケーションでは、いくつかの OLE DB データベースで使用される接続文字列を作成します。最初に、Microsoft Access データベース用の接続文字列を作成した後、IBM DB2 データベース用の接続文字列を作成します。また、既存の接続文字列を解析し、接続文字列の内容に対して各種の操作を行う例が示されています。
![]() |
---|
この例には、OleDbConnectionStringBuilder と接続文字列がどのように連携するかを示すパスワードが含まれています。アプリケーションでは、Windows 認証の使用をお勧めします。パスワードを使用する必要がある場合は、ハードコーディングされたパスワードをアプリケーションに組み込まないでください。 |
Imports System.Data.OleDb Imports System.Collections Module Module1 Sub Main() Dim builder As New OleDbConnectionStringBuilder() builder.ConnectionString = "Data Source=C:\Sample.mdb" ' Call the Add method to explicitly add key/value ' pairs to the internal collection. builder.Add("Provider", "Microsoft.Jet.Oledb.4.0") builder.Add("Jet OLEDB:Database Password", "MyPassword!") builder.Add("Jet OLEDB:System Database", "C:\Workgroup.mdb") ' Set up row-level locking. builder.Add("Jet OLEDB:Database Locking Mode", 1) Console.WriteLine(builder.ConnectionString) Console.WriteLine() ' Clear current values and reset known keys to their ' default values. builder.Clear() ' Pass the OleDbConnectionStringBuilder an existing ' connection string, and you can retrieve and ' modify any of the elements. builder.ConnectionString = _ "Provider=DB2OLEDB;Network Transport Library=TCPIP;" & _ "Network Address=192.168.0.12;Initial Catalog=DbAdventures;" & _ "Package Collection=SamplePackage;Default Schema=SampleSchema;" Console.WriteLine("Network Address = " & builder("Network Address").ToString()) Console.WriteLine() ' Modify existing items. builder("Package Collection") = "NewPackage" builder("Default Schema") = "NewSchema" ' Call the Remove method to remove items from ' the collection of key/value pairs. builder.Remove("User ID") ' Note that calling Remove on a nonexistent item does not ' throw an exception. builder.Remove("BadItem") Console.WriteLine(builder.ConnectionString) Console.WriteLine() ' The Item property is the default for the class, ' and setting the Item property adds the value, if ' necessary. builder("User ID") = "SampleUser" builder("Password") = "SamplePassword" Console.WriteLine(builder.ConnectionString) Console.WriteLine("Press Enter to finish.") Console.ReadLine() End Sub End Module
using System.Data.OleDb; class Program { static void Main(string[] args) { OleDbConnectionStringBuilder builder = new OleDbConnectionStringBuilder(); builder.ConnectionString = @"Data Source=C:\Sample.mdb"; // Call the Add method to explicitly add key/value // pairs to the internal collection. builder.Add("Provider", "Microsoft.Jet.Oledb.4.0"); builder.Add("Jet OLEDB:Database Password", "MyPassword!"); builder.Add("Jet OLEDB:System Database", @"C:\Workgroup.mdb"); // Set up row-level locking. builder.Add("Jet OLEDB:Database Locking Mode", 1); Console.WriteLine(builder.ConnectionString); Console.WriteLine(); // Clear current values and reset known keys to their // default values. builder.Clear(); // Pass the OleDbConnectionStringBuilder an existing // connection string, and you can retrieve and // modify any of the elements. builder.ConnectionString = "Provider=DB2OLEDB;Network Transport Library=TCPIP;" + "Network Address=192.168.0.12;Initial Catalog=DbAdventures;" + "Package Collection=SamplePackage;Default Schema=SampleSchema;"; Console.WriteLine("Network Address = " + builder["Network Address"].ToString()); Console.WriteLine(); // Modify existing items. builder["Package Collection"] = "NewPackage"; builder["Default Schema"] = "NewSchema"; // Call the Remove method to remove items from // the collection of key/value pairs. builder.Remove("User ID"); // Note that calling Remove on a nonexistent item does not // throw an exception. builder.Remove("BadItem"); Console.WriteLine(builder.ConnectionString); Console.WriteLine(); // Setting the indexer adds the value, if // necessary. builder["User ID"] = "SampleUser"; builder["Password"] = "SamplePassword"; Console.WriteLine(builder.ConnectionString); Console.WriteLine("Press Enter to finish."); Console.ReadLine(); } }

System.Data.Common.DbConnectionStringBuilder
System.Data.OleDb.OleDbConnectionStringBuilder


Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


OleDbConnectionStringBuilder コンストラクタ ()
アセンブリ: System.Data (system.data.dll 内)


Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


OleDbConnectionStringBuilder コンストラクタ

名前 | 説明 |
---|---|
OleDbConnectionStringBuilder () | OleDbConnectionStringBuilder クラスの新しいインスタンスを初期化します。 |
OleDbConnectionStringBuilder (String) | OleDbConnectionStringBuilder クラスの新しいインスタンスを初期化します。引数に渡した接続文字列によって、インスタンスの内部的な接続情報のデータが提供されます。 |

OleDbConnectionStringBuilder コンストラクタ (String)
アセンブリ: System.Data (system.data.dll 内)



Provider プロパティを設定すると、直接 ConnectionString プロパティを設定するか、接続文字列をパラメータとしてコンストラクタに渡すかにかかわらず、OleDbConnectionStringBuilder インスタンス内に保持されるキー/値ペアに影響を与えます。たとえば、Provider プロパティを "sqloledb" に設定すると、標準的な SQL 接続文字列のプロパティがすべて追加されます。実際の例については、このトピックに示したコードを参照してください。
プロバイダによっては、OleDbConnectionStringBuilder コンストラクタ内に接続文字列を割り当てると、指定したキー/値ペアの順序が変更される場合があります。

次の例では、複数の OleDbConnectionStringBuilder インスタンスを作成し、それぞれの場合について異なる接続文字列をコンストラクタに渡しています。接続に使用するプロバイダを設定することによって、定義済みのキー/値ペアが、オブジェクトのコレクション内でどのように変わるかに注意してください。
![]() |
---|
この例には、OleDbConnectionStringBuilder と接続文字列がどのように連携するかを示すパスワードが含まれています。アプリケーションでは、Windows 認証の使用をお勧めします。パスワードを使用する必要がある場合は、ハードコーディングされたパスワードをアプリケーションに組み込まないでください。 |
Imports System.Data.OleDb Module Module1 Sub Main() Try ' Build an empty instance, just to see ' the contents of the keys. DumpBuilderContents("") ' Create a SQL Server connection string. DumpBuilderContents("Provider=sqloledb;Data Source=(local);" & _ "Initial Catalog=AdventureWorks;" & _ "User Id=ab;Password=Password@1") ' Create an Access connection string. DumpBuilderContents("Provider=Microsoft.Jet.OLEDB.4.0;" & _ "Data Source=C:\Sample.mdb") ' Create an Oracle connection string. DumpBuilderContents("Provider=msdaora;Data Source=SomeOracleDb;" & _ "User Id=userName;Password=Pass@word1;") ' Create a Sybase connection string. DumpBuilderContents("Provider=ASAProv;Data source=myASA") Console.WriteLine("Press any key to finish.") Console.ReadLine() Catch ex As System.ArgumentException Console.WriteLine("Error: " & ex.Message) End Try End Sub Private Sub DumpBuilderContents(ByVal connectString As String) Dim builder As New OleDbConnectionStringBuilder(connectString) Console.WriteLine("=================") Console.WriteLine("Original connectString = " & connectString) Console.WriteLine("builder.ConnectionString = " & builder.ConnectionString) For Each key As String In builder.Keys Console.WriteLine(key & "=" & builder.Item(key).ToString) Next End Sub End Module
using System.Data.OleDb; class Program { static void Main() { try { // Build an empty instance, just to see // the contents of the keys. DumpBuilderContents(""); // Create a SQL Server connection string. DumpBuilderContents("Provider=sqloledb;Data Source=(local);" + "Initial Catalog=AdventureWorks;" + "User Id=ab;Password=Password@1"); // Create an Access connection string. DumpBuilderContents("Provider=Microsoft.Jet.OLEDB.4.0;" + @"Data Source=C:\Sample.mdb"); // Create an Oracle connection string. DumpBuilderContents("Provider=msdaora;Data Source=SomeOracleDb;" + "User Id=userName;Password=Pass@word1;"); // Create an Sybase connection string. DumpBuilderContents("Provider=ASAProv;Data source=myASA"); Console.WriteLine("Press any key to finish."); Console.ReadLine(); } catch (System.ArgumentException ex) { Console.WriteLine("Error: " + ex.Message); } } private static void DumpBuilderContents(string connectString) { OleDbConnectionStringBuilder builder = new OleDbConnectionStringBuilder(connectString); Console.WriteLine("================="); Console.WriteLine("Original connectString = " + connectString); Console.WriteLine("builder.ConnectionString = " + builder.ConnectionString); foreach (string key in builder.Keys) { Console.WriteLine(key + "=" + builder[key].ToString()); } } }

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。


OleDbConnectionStringBuilder プロパティ

名前 | 説明 | |
---|---|---|
![]() | BrowsableConnectionString | ConnectionString プロパティが Visual Studio デザイナに表示できるかどうかを指定する値を取得または設定します。 ( DbConnectionStringBuilder から継承されます。) |
![]() | ConnectionString | DbConnectionStringBuilder に関連付けられる接続文字列を取得または設定します。 ( DbConnectionStringBuilder から継承されます。) |
![]() | Count | ConnectionString プロパティに格納されている、現在のキー数を取得します。 ( DbConnectionStringBuilder から継承されます。) |
![]() | DataSource | 接続先のデータ ソースの名前を取得または設定します。 |
![]() | FileName | データ ソースへの接続に使用する汎用データ リンク (UDL) ファイルの名前を取得または設定します。 |
![]() | IsFixedSize | DbConnectionStringBuilder が固定サイズかどうかを示す値を取得します。 ( DbConnectionStringBuilder から継承されます。) |
![]() | IsReadOnly | DbConnectionStringBuilder が読み取り専用かどうかを示す値を取得します。 ( DbConnectionStringBuilder から継承されます。) |
![]() | Item | オーバーライドされます。 指定したキーに関連付けられている値を取得または設定します。C# では、このプロパティはインデクサです。 |
![]() | Keys | オーバーライドされます。 OleDbConnectionStringBuilder 内のキーを格納している ICollection を取得します。 |
![]() | OleDbServices | 接続文字列の中で OLE DB Services キーに対応する値を取得または設定します。 |
![]() | PersistSecurityInfo | 接続が開いているか、開いている状態になったことがある場合に、パスワードなどの機密性の高い情報を接続文字列の一部として返すかどうかを示すブール値を取得または設定します。 |
![]() | Provider | 接続文字列に関連付けられたデータ プロバイダの名前を内部的に保持する文字列を取得または設定します。 |
![]() | Values | DbConnectionStringBuilder 内の値を格納している ICollection を取得します。 ( DbConnectionStringBuilder から継承されます。) |

OleDbConnectionStringBuilder メソッド

名前 | 説明 | |
---|---|---|
![]() | Add | 指定したキーおよび値を持つエントリを DbConnectionStringBuilder に追加します。 ( DbConnectionStringBuilder から継承されます。) |
![]() | AppendKeyValuePair | オーバーロードされます。 効率的かつ安全に、既存の StringBuilder オブジェクトにキーと値を追加できます。 ( DbConnectionStringBuilder から継承されます。) |
![]() | Clear | オーバーライドされます。 OleDbConnectionStringBuilder インスタンスの内容を消去します。 |
![]() | ContainsKey | オーバーライドされます。 OleDbConnectionStringBuilder に特定のキーが格納されているかどうかを判断します。 |
![]() | Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。) |
![]() | EquivalentTo | この DbConnectionStringBuilder オブジェクト内の接続情報と、指定したオブジェクト内の接続情報を比較します。 ( DbConnectionStringBuilder から継承されます。) |
![]() | GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。) |
![]() | GetType | 現在のインスタンスの Type を取得します。 ( Object から継承されます。) |
![]() | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。) |
![]() | Remove | オーバーライドされます。 指定したキーを持つエントリを OleDbConnectionStringBuilder インスタンスから削除します。 |
![]() | ShouldSerialize | 指定されたキーが、この DbConnectionStringBuilder インスタンスに存在するかどうかを示します。 ( DbConnectionStringBuilder から継承されます。) |
![]() | ToString | この DbConnectionStringBuilder に関連付けられている接続文字列を返します。 ( DbConnectionStringBuilder から継承されます。) |
![]() | TryGetValue | オーバーライドされます。 指定されたキーに対応する値を OleDbConnectionStringBuilder のインスタンスから取得します。 |

名前 | 説明 | |
---|---|---|
![]() | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。) |
![]() | MemberwiseClone | 現在の Object の簡易コピーを作成します。 ( Object から継承されます。) |

OleDbConnectionStringBuilder メンバ
OleDbConnection クラスで使用する接続文字列の内容の作成と管理を簡単に実行できるようにします。
OleDbConnectionStringBuilder データ型で公開されるメンバを以下の表に示します。


名前 | 説明 | |
---|---|---|
![]() | BrowsableConnectionString | ConnectionString プロパティが Visual Studio デザイナに表示できるかどうかを指定する値を取得または設定します。(DbConnectionStringBuilder から継承されます。) |
![]() | ConnectionString | DbConnectionStringBuilder に関連付けられる接続文字列を取得または設定します。(DbConnectionStringBuilder から継承されます。) |
![]() | Count | ConnectionString プロパティに格納されている、現在のキー数を取得します。(DbConnectionStringBuilder から継承されます。) |
![]() | DataSource | 接続先のデータ ソースの名前を取得または設定します。 |
![]() | FileName | データ ソースへの接続に使用する汎用データ リンク (UDL) ファイルの名前を取得または設定します。 |
![]() | IsFixedSize | DbConnectionStringBuilder が固定サイズかどうかを示す値を取得します。(DbConnectionStringBuilder から継承されます。) |
![]() | IsReadOnly | DbConnectionStringBuilder が読み取り専用かどうかを示す値を取得します。(DbConnectionStringBuilder から継承されます。) |
![]() | Item | オーバーライドされます。 指定したキーに関連付けられている値を取得または設定します。C# では、このプロパティはインデクサです。 |
![]() | Keys | オーバーライドされます。 OleDbConnectionStringBuilder 内のキーを格納している ICollection を取得します。 |
![]() | OleDbServices | 接続文字列の中で OLE DB Services キーに対応する値を取得または設定します。 |
![]() | PersistSecurityInfo | 接続が開いているか、開いている状態になったことがある場合に、パスワードなどの機密性の高い情報を接続文字列の一部として返すかどうかを示すブール値を取得または設定します。 |
![]() | Provider | 接続文字列に関連付けられたデータ プロバイダの名前を内部的に保持する文字列を取得または設定します。 |
![]() | Values | DbConnectionStringBuilder 内の値を格納している ICollection を取得します。(DbConnectionStringBuilder から継承されます。) |

名前 | 説明 | |
---|---|---|
![]() | Add | 指定したキーおよび値を持つエントリを DbConnectionStringBuilder に追加します。 (DbConnectionStringBuilder から継承されます。) |
![]() | AppendKeyValuePair | オーバーロードされます。 効率的かつ安全に、既存の StringBuilder オブジェクトにキーと値を追加できます。 (DbConnectionStringBuilder から継承されます。) |
![]() | Clear | オーバーライドされます。 OleDbConnectionStringBuilder インスタンスの内容を消去します。 |
![]() | ContainsKey | オーバーライドされます。 OleDbConnectionStringBuilder に特定のキーが格納されているかどうかを判断します。 |
![]() | Equals | オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。) |
![]() | EquivalentTo | この DbConnectionStringBuilder オブジェクト内の接続情報と、指定したオブジェクト内の接続情報を比較します。 (DbConnectionStringBuilder から継承されます。) |
![]() | GetHashCode | 特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。) |
![]() | GetType | 現在のインスタンスの Type を取得します。 (Object から継承されます。) |
![]() | ReferenceEquals | 指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。) |
![]() | Remove | オーバーライドされます。 指定したキーを持つエントリを OleDbConnectionStringBuilder インスタンスから削除します。 |
![]() | ShouldSerialize | 指定されたキーが、この DbConnectionStringBuilder インスタンスに存在するかどうかを示します。 (DbConnectionStringBuilder から継承されます。) |
![]() | ToString | この DbConnectionStringBuilder に関連付けられている接続文字列を返します。 (DbConnectionStringBuilder から継承されます。) |
![]() | TryGetValue | オーバーライドされます。 指定されたキーに対応する値を OleDbConnectionStringBuilder のインスタンスから取得します。 |

名前 | 説明 | |
---|---|---|
![]() | Finalize | Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。) |
![]() | MemberwiseClone | 現在の Object の簡易コピーを作成します。 (Object から継承されます。) |

- OleDbConnectionStringBuilderのページへのリンク