SQLDrivers 関数

適合 性
導入バージョン: ODBC 2.0 Standards Compliance: ODBC

Summary
SQLDrivers はドライバーの記述とドライバー属性キーワードを一覧にします。 この機能はドライバーマネージャーのみによって実装されます。

構文

  
SQLRETURN SQLDrivers(  
     SQLHENV         EnvironmentHandle,  
     SQLUSMALLINT    Direction,  
     SQLCHAR *       DriverDescription,  
     SQLSMALLINT     BufferLength1,  
     SQLSMALLINT *   DescriptionLengthPtr,  
     SQLCHAR *       DriverAttributes,  
     SQLSMALLINT     BufferLength2,  
     SQLSMALLINT *   AttributesLengthPtr);  

引数

EnvironmentHandle
[入力]環境の取り扱い。

方向
[入力]ドライバーマネージャーがリスト内の次のドライバー記述を取得するか(SQL_FETCH_NEXT)、それとも検索をリストの冒頭から始めるか(SQL_FETCH_FIRST)を決定します。

DriverDescription
[出力]ドライバーの記述を返すためのバッファへのポインタ。

DriverDescriptionがNULLの場合、DescriptionLengthPtr はDriverDescriptionが指すバッファ内で返せる文字数(文字データのnull終端文字を除く)を返します。

バッファ長1
[入力]*DriverDescription バッファの長さ(文字数)。

説明LengthPtr
[出力]*DriverDescriptionで返せる文字数(null終端文字を除く)を返すバッファへのポインタ。 返せる文字数が BufferLength1以上の場合、*DriverDescription のドライバ記述はnull終端文字の長さを引いた BufferLength1 に切り詰められます。

ドライバー属性
[出力]ドライバー属性値ペアのリストを返すためのバッファへのポインタ(「コメント」参照)。

DriverAttributesがNULLの場合、AttributesLengthPtr はDriverAttributesが指すバッファ内で返せる合計バイト数(文字データのnull終端文字を除く)を返します。

バッファレングス2
[入力]*DriverAttributes バッファの長さ(文字数)です。 * DriverDescription 値が Unicode 文字列(SQLDriversW 呼び出し時)の場合、 BufferLength 引数は偶数でなければなりません。

属性長Ptr
[出力]*DriverAttributesで返せる合計バイト数(null終端バイトを除く)を返すためのバッファへのポインタ。 返すバイト数が BufferLength2以上の場合、*DriverAttributes の属性値ペアのリストは BufferLength2 からnull終端文字の長さを引いたものに切り詰められます。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_NO_DATA、SQL_ERROR、SQL_INVALID_HANDLE。

Diagnostics

SQLDriversがSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合、SQLGetDiagRecを呼び出し、HandleTypeをSQL_HANDLE_ENV、HandleをenvironmentHandleで呼び出すことで関連するSQLSTATE値を取得できます。 以下の表は 、SQLDrivers が通常返すSQLSTATE値を一覧にし、それぞれをこの関数の文脈で説明しています。「(DM)」という表記は、ドライバーマネージャーが返すSQLstateの記述の前に記載されます。 特に明記されていない限り、各 SQLSTATE 値に関連付けられている戻りコードはSQL_ERROR。

Comments

SQLDrivers は*DriverDescription バッファ内のドライバー記述を返します。 これは*DriverAttributes バッファ内のドライバーに関する追加情報をキーワードと値の組み合わせのリストとして返します。 ドライバのシステム情報に記載されているすべてのキーワードは、データソースの作成を促すために使われるCreateDSNを除き、すべてのドライバーで返されます。 CreateDSNは任意です。 各ペアはヌルバイトで終了し、完全なリストはヌルバイトで終了します(つまりリストの終わりに2つのヌルバイトが付けられます)。 例えば、C構文を用いたファイルベースのドライバでは、以下の属性リスト(「\0」はヌル文字を表します):

FileUsage=1\0FileExtns=*.dbf\0\0  

*DriverAttributes がリスト全体を保持するには十分でない場合はリストを切り捨て、 SQLDrivers はSQLSTATE 01004(データ切り捨て)を返し、リストの長さ(最後のnull終端バイトを除く)は*AttributesLengthPtrで返されます。

ドライバー属性キーワードは、ドライバーをインストールする際にシステム情報から追加されます。 詳細は「 ODBCコンポーネントのインストール」をご覧ください。

アプリケーションは SQLDrivers を複数回呼び出してすべてのドライバー記述を取得することができます。 ドライバーマネージャーはこの情報をシステム情報から取得します。 ドライバーの記述がなくなった場合は、 SQLDriversが SQL_NO_DATAを返します。 SQLDriversがSQL_NO_DATAを返した直後にSQL_FETCH_NEXTで呼び出されると、最初のドライバー記述を返します。 アプリケーションが SQLDriversから返される情報をどのように利用するかについては、「 データソースまたはドライバーの選択」を参照してください。

SQL_FETCH_NEXTが最初に呼び出されたときに SQLDrivers に渡されると、 SQLDrivers は最初のデータソース名を返します。

SQLDriversはドライバーマネージャーで実装されているため、特定のドライバーの標準に準拠しているかどうかに関わらず、すべてのドライバーでサポートされています。

関連関数

関連するコンテンツ

• ODBC API リファレンス
• ODBC ヘッダー ファイル