OdbcConnection.ConnectionString プロパティ

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

OdbcConnection.ConnectionString プロパティ

データ ソースを開くために使用する文字列を取得または設定します。

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

Visual Basic (宣言)

Public Overrides Property
 ConnectionString As String

Visual Basic (使用法)

Dim instance As OdbcConnection
Dim value As String

value = instance.ConnectionString

instance.ConnectionString = value

C#

public override string ConnectionString { get;
 set; }

C++

public:
virtual property String^ ConnectionString {
    String^ get () override;
    void set (String^ value) override;
}

J#

/** @property */
public String get_ConnectionString ()

/** @property */
public void set_ConnectionString (String value)

JScript

public override function get
 ConnectionString () : String

public override function set
 ConnectionString (value : String)

プロパティ値
データ ソース名など、初期接続を確立するために必要な設定を含む ODBC ドライバ接続文字列。既定値は空の文字列 ("") です。最大の長さは、1024 文字です。

解説

ConnectionString プロパティは、可能な限り ODBC 接続文字列の書式と一致するように設計されています。ConnectionString は、接続が閉じているときにだけ設定できます。設定が完了すると、そのまま Driver Manager および基になるドライバに渡されます。そのため、ConnectionString の構文は、Driver Manager および基になるドライバがサポートしている構文と完全に一致している必要があります。

ConnectionString プロパティを使用して、さまざまなデータ ソースに接続できます。これには、ODBC データ ソース名 (DSN) も含まれます。接続文字列の例を次に示します。

"Driver={SQL Server};Server=(local);Trusted_Connection=Yes;Database=AdventureWorks;"

"Driver={Microsoft ODBC for Oracle};Server=ORACLE8i7;Persist Security Info=False;Trusted_Connection=Yes"

"Driver={Microsoft Access Driver (*.mdb)};DBQ=c:\bin\Northwind.mdb"

"Driver={Microsoft Excel Driver (*.xls)};DBQ=c:\bin\book1.xls"

"Driver={Microsoft Text Driver (*.txt; *.csv)};DBQ=c:\bin"

"DSN=dsnname"

メモ
.NET Framework ODBC 用データ プロバイダでは、他の .NET Framework データ プロバイダで使用可能な Persist Security Info キーワードを利用できません。ただし、ConnectionString プロパティは、Persist Security Info を false に設定した場合と同様に機能します。そのため、接続が開いているときに ConnectionString プロパティからパスワードを取得することはできません。開いている OdbcConnection オブジェクトから ConnectionString プロパティを読み取った場合、パスワードを除いた接続文字列が返されます。この動作は、変更できません。そのため、アプリケーションでパスワードが必要な場合は、Open を呼び出す前にパスワードを別に格納してください。

接続文字列で指定する設定の多くには、それぞれに対応する読み取り専用プロパティが存在します (DataSource プロパティに対応する Server=(local) など)。エラーが検出された場合を除いて、これらのプロパティは、接続が開かれた後に更新されます。エラーが発生した場合は、いずれのプロパティも更新されません。OdbcConnection のプロパティ (Database など) は、既定の設定、または ConnectionString で指定されている設定だけを返します。

Microsoft .NET Framework Version 1.0 では、アプリケーションが Open メソッドを呼び出すまで、接続文字列は検証されません。接続文字列の検証は、基になる ODBC ドライバが行います。接続文字列に無効なプロパティ、またはサポートされていないプロパティが含まれている場合は、実行時にドライバで OdbcException が発生する可能性があります。

ただし、.NET Framework Version 1.1 以降では、ConnectionString プロパティを設定した直後に、接続文字列に対していくつかの基本的な検証が行われます。このとき、データ プロバイダは、接続文字列が keyword=value;... の書式で設定されているかどうかを検証しますが、キーワードや値が有効かどうかは検証しません。残りの検証は、アプリケーションが Open メソッドを呼び出したときに、基になる ODBC ドライバが実行します。

ODBC 接続文字列の構文を次に示します。

connection-string ::= empty-string[;] | attribute[;] | attribute; connection-string
empty-string ::=
attribute ::= attribute-keyword=attribute-value | DRIVER=[{]attribute-value[}]
attribute-keyword ::= DSN | UID | PWD
 | driver-defined-attribute-keyword
attribute-value ::= character-string
driver-defined-attribute-keyword ::= identifier

character-string は 0 文字以上の文字、identifier は、1 文字以上の文字です。attribute-keyword の大文字と小文字は区別されません。attribute-value の大文字と小文字は区別されることがあります。また、空白だけによって構成される DSN キーワードを使用することはできません。

接続文字列と初期化ファイルの文法により、[]{}(),;?*=!@ 文字を含むキーワード値および属性値は中かっこで囲む必要があります。DSN キーワードの値は、空白だけで構成することはできず、空白で開始することもできません。システム情報の文法により、キーワードおよびデータ ソース名に円記号 (\) を含めることはできません。

属性にセミコロン (;) が含まれていない限り、アプリケーションで Driver キーワードの後の属性値を中かっこで囲む必要はありません。属性にセミコロンが含まれている場合は、中かっこが必要です。ドライバが受信した属性値に中かっこが含まれている場合、ドライバは中かっこを削除せず、中かっこは返される接続文字列の一部になります。

[]{}(),;?*=!@ 文字のいずれかを含み、中かっこ ({}) で囲まれている DSN または接続文字列値は、そのままドライバに渡されます。これらの文字をキーワードで使用している場合、Driver Manager は、DSN ファイルの処理時にエラーを返しますが、その接続文字列を通常の接続文字列としてドライバに渡します。キーワード値の中に中かっこを使用しないでください。

接続文字列には、ドライバで定義されているキーワードをいくつでも使用できます。DRIVER キーワードはシステムの情報を使用しないため、ドライバが接続文字列の情報だけを使用してデータ ソースに接続できるように、ドライバで十分なキーワードを定義する必要があります。ドライバで、データ ソースに接続するために必要なキーワードを定義します。

接続文字列内でいずれかのキーワードが繰り返されている場合、どの値が選択されるかについての保証はありません。

メモ
ODBC ドライバが 1024 文字以上の接続文字列をサポートしている場合は、最大長の制限を超えたデータ ソース名 (DSN) を使用できます。

プラットフォーム

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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1

参照

関連項目
OdbcConnection クラス
OdbcConnection メンバ
System.Data.Odbc 名前空間
その他の技術情報
データ ソースへの接続