SQLGetInfo 関数

準拠
導入されたバージョン: ODBC 1.0 標準コンプライアンス: ISO 92

まとめ
SQLGetInfo は、接続に関連付けられているドライバーとデータ ソースに関する一般的な情報を返します。

構文

  
SQLRETURN SQLGetInfo(  
     SQLHDBC         ConnectionHandle,  
     SQLUSMALLINT    InfoType,  
     SQLPOINTER      InfoValuePtr,  
     SQLSMALLINT     BufferLength,  
     SQLSMALLINT *   StringLengthPtr);  

引数

ConnectionHandle
[入力] 接続ハンドル。

InfoType
[入力]情報の種類。

InfoValuePtr
[出力]情報を返すバッファーへのポインター。 要求された InfoType に応じて、返される情報は、null で終わる文字列、SQLUSMALLINT 値、SQLUINTEGER ビットマスク、SQLUINTEGER フラグ、SQLUINTEGER バイナリ値、または SQLULEN 値のいずれかになります。

InfoType引数がSQL_DRIVER_HDESCまたはSQL_DRIVER_HSTMTの場合、InfoValuePtr 引数は入力と出力の両方になります。 (詳細については、この関数の説明で後述するSQL_DRIVER_HDESCまたはSQL_DRIVER_HSTMT記述子を参照してください。

InfoValuePtr が NULL の場合、StringLengthPtr は引き続き、InfoValuePtr が指すバッファーで返すことができる合計バイト数 (文字データの null 終端文字を除く) を返します。

BufferLength
[入力]*InfoValuePtr バッファーの長さ。 *InfoValuePtr の値が文字列でない場合、または InfoValuePtr が null ポインターの場合、BufferLength 引数は無視されます。 ドライバーは、 *InfoValuePtr のサイズが、 InfoType に基づいて SQLUSMALLINT または SQLUINTEGER であると想定しています。 *InfoValuePtr が Unicode 文字列の場合 (SQLGetInfoW を呼び出すとき)、引数 BufferLength は偶数である必要があります。そうでない場合は、SQLSTATE HY090 (文字列またはバッファーの長さが無効です) が返されます。

StringLengthPtr
[出力]*InfoValuePtr で返すことができる合計バイト数 (文字データの null 終端文字を除く) を返すバッファーへのポインター。

文字データの場合、返されるバイト数が BufferLength 以上の場合、*InfoValuePtr 内の情報は、 BufferLength バイトから null 終端文字の長さを引いた値に切り捨てられ、ドライバーによって null で終了されます。

その他のすべての種類のデータでは、BufferLength の値は無視され、ドライバーでは、InfoType に応じて、*InfoValuePtr のサイズが SQLUSMALLINT または SQLUINTEGER であると見なされます。

返品

SQL_SUCCESS、SQL_SUCCESS_WITH_INFO、SQL_ERROR、またはSQL_INVALID_HANDLE。

診断

SQLGetInfoがSQL_ERRORまたはSQL_SUCCESS_WITH_INFOを返す場合は、SQL_HANDLE_DBCのHandleTypeとconnectionHandleのHandleを使用してSQLGetDiagRecを呼び出すことによって、関連付けられた SQLSTATE 値取得できます。 次の表に、 SQLGetInfo によって通常返される SQLSTATE 値の一覧を示し、この関数のコンテキストでそれぞれについて説明します。表記 "(DM)" は、ドライバー マネージャーによって返される SQLSTATEs の説明の前にあります。 特に明記されていない限り、各 SQLSTATE 値に関連付けられている戻りコードはSQL_ERROR。

Comments

現在定義されている情報の種類については、このセクションで後述する「情報の種類」を参照してください。さまざまなデータ ソースを利用するために、より多くの定義が行われると予想されます。 情報の種類の範囲は ODBC によって予約されています。ドライバー開発者は、オープン グループから独自のドライバー固有の使用のために値を予約する必要があります。 SQLGetInfo は、ドライバー定義のInfoTypesに対して Unicode 変換またはthunking (ODBC プログラマーリファレンスの「APPendix A: ODBC エラー コード」を参照) を実行しません。 詳細については、「ドライバー固有のデータ型、記述子の種類、情報の種類、診断型、および属性」を参照してください。 *InfoValuePtr で返される情報の形式は、要求された InfoType によって異なります。 SQLGetInfo は、次の 5 つの形式のいずれかで情報を返します。

• null で終わる文字列

• SQLUSMALLINT 値

• SQLUINTEGER ビットマスク

• SQLUINTEGER 値

• SQLUINTEGER バイナリ値

次の各情報の種類の形式は、型の説明に記載されています。 アプリケーションは、*InfoValuePtr で返される値を適宜キャストする必要があります。 アプリケーションが SQLUINTEGER ビットマスクからデータを取得する方法の例については、「コード例」を参照してください。

ドライバーは、次の表で定義されている各情報の種類の値を返す必要があります。 情報の種類がドライバーまたはデータ ソースに適用されない場合、ドライバーは次の表に示す値のいずれかを返します。

たとえば、データ ソースがプロシージャをサポートしていない場合、 SQLGetInfo は、プロシージャに関連する InfoType の値について、次の表に示す値を返します。

SQLGetInfo は、ODBC で使用するために予約されているが、ドライバーでサポートされている ODBC のバージョンでは定義されていない情報の種類の範囲内にある InfoType の値の SQLSTATE HY096 (無効な引数値) を返します。 ドライバーが準拠している ODBC のバージョンを確認するために、アプリケーションはSQL_DRIVER_ODBC_VER情報の種類SQLGetInfo を呼び出します。 SQLGetInfo は、ドライバー固有の使用のために予約されているが、ドライバーでサポートされていない情報の種類の範囲内にある InfoType の値の SQLSTATE HYC00 (省略可能な機能は実装されていません) を返します。

SQLGetInfoのすべての呼び出しには、ドライバー マネージャーのバージョンを返す InfoType がSQL_ODBC_VERされている場合を除き、開いている接続が必要です。

情報の種類

このセクションでは、 SQLGetInfo でサポートされる情報の種類を示します。 情報の種類はカテゴリ別にグループ化され、アルファベット順に一覧表示されます。 ODBC 3*.x* に対して追加または名前変更された情報の種類も一覧表示されます。

ドライバー情報

InfoType 引数の次の値は、アクティブなステートメントの数、データ ソース名、インターフェイス標準コンプライアンス レベルなど、ODBC ドライバーに関する情報を返します。

DBMS 製品情報

InfoType 引数の次の値は、DBMS の名前やバージョンなど、DBMS 製品に関する情報を返します。

データ ソース情報

InfoType 引数の次の値は、カーソルの特性やトランザクション機能など、データ ソースに関する情報を返します。

サポートされている SQL

InfoType 引数の次の値は、データ ソースでサポートされている SQL ステートメントに関する情報を返します。 これらの情報の種類で説明されている各機能の SQL 構文は、SQL-92 構文です。 これらの情報の種類では、SQL-92 文法全体が完全に記述されているわけではありません。 代わりに、通常、データ ソースがさまざまなレベルのサポートを提供する文法のこれらの部分について説明します。 具体的には、SQL-92 の DDL ステートメントのほとんどについて説明します。

アプリケーションは、SQL_SQL_CONFORMANCE情報の種類からサポートされている文法の一般的なレベルを決定し、他の情報の種類を使用して、指定された標準コンプライアンス レベルからのバリエーションを決定する必要があります。

SQL の制限

InfoType引数の次の値は、識別子の最大長や選択リスト内の列の最大数など、SQL ステートメントの識別子と句に適用される制限に関する情報を返します。 制限は、ドライバーまたはデータ ソースによって適用できます。

スカラー関数情報

InfoType 引数の次の値は、データ ソースとドライバーでサポートされているスカラー関数に関する情報を返します。 スカラー関数の詳細については、「 Appendix E: スカラー関数」を参照してください。

変換情報

InfoType 引数の次の値は、CONVERT スカラー関数を使用して、データ ソースが指定した SQL データ型を変換できる SQL データ型の一覧を返します。

ODBC 3.x に追加された情報の種類

ODBC 3.x に InfoType 引数の次の値が追加されました。

ODBC 3.x で名前が変更された情報の種類

ODBC 3.x では、 InfoType 引数の次の値の名前が変更されました。

ODBC 3.x で非推奨になった情報の種類

ODBC 3.x では、 InfoType 引数の次の値が非推奨になりました。 ODBC 3.x ドライバーは、ODBC 2.x アプリケーションとの下位互換性のために、これらの情報の種類を引き続きサポートする必要があります。 (これらの型の詳細については、 を参照してください。SQLGetInfo のサポート 付録 G: 下位互換性のためのドライバー ガイドライン)。

情報の種類の説明

次の表は、各情報の種類、導入された ODBC のバージョン、およびその説明をアルファベット順に示しています。

例

SQLGetInfo は、サポートされているオプションの一覧を *InfoValuePtr の SQLUINTEGER ビットマスクとして返します。 各オプションのビットマスクは、オプションがサポートされているかどうかを判断するためにフラグと共に使用されます。

たとえば、アプリケーションでは、次のコードを使用して、接続に関連付けられているドライバーで SUBSTRING スカラー関数がサポートされているかどうかを判断できます。

SQLGetInfo の使用例については、「SQLTables 関数」を参照してください。

SQLUINTEGER fFuncs;  
  
SQLGetInfo(hdbc,  
           SQL_STRING_FUNCTIONS,  
           (SQLPOINTER)&fFuncs,  
           sizeof(fFuncs),  
           NULL);  
  
// SUBSTRING supported  
if (fFuncs & SQL_FN_STR_SUBSTRING)  
   ;   // do something  
  
// SUBSTRING not supported  
else  
   ;   // do something else  

関連する関数

接続属性の設定を返す
SQLGetConnectAttr 関数

ドライバーが関数をサポートしているかどうかを判断する
SQLGetFunctions 関数

ステートメント属性の設定を返す
SQLGetStmtAttr 関数

データ ソースのデータ型に関する情報を返す
SQLGetTypeInfo 関数

参照

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