CLI の手引きおよび解説書

第 5 章 DB2 CLI 関数

このセクションでは、各 DB2 CLI 関数をアルファベット順に説明します。さらに、DB2 CLI 関数の要約にはカテゴリー別の関数表があります。それぞれの説明には、以下の項目があります。

次に、それぞれの項について説明します。

DB2 CLI バージョン 5 以降におけるこの関数の状況
この項は、バージョン 5 で新しい関数で置き換えられたバージョン 2 関数だけに含まれます。

この項では、どんな新規関数を使用するのか、および旧関数の代わりに新規関数を使用する方法について説明します。

目的
この項では、関数の機能に関する簡単な概要を示します。また、説明されている関数を呼び出す前後にいずれかの関数を呼び出さなければならないかどうかも示します。

各関数には、次の表のような、その関数がどの仕様または標準に準拠するかを示す表もあります。最初の列は、DB2 CLI のどのレベルから関数が準拠しているかを示し、 2 番目の列は、ODBC のどのバージョン (1.0、2.0、または 3.0) から準拠しているかを示します。最後の列は、関数が ISO CLI 規格に含まれているかどうかを示します。
注:この表は関数のサポートを示しています。関数の中にはすべての仕様または規格が適用されない一連のオプションを使用するものがあります。制限の項には、重要な相違点が示されています。


表 11. 関数仕様表の例
仕様: DB2 CLI 1.1 ODBC 1.0 ISO CLI

構文
この項には、汎用 'C' プロトタイプが含まれています。汎用プロトタイプは、Windows を含むすべての環境に使用されます。

注:ポインターであるすべての関数実引き数は、マクロ FAR を使用して定義されますが、このマクロは Windows を除くすべてのプラットフォームで除外定義 (ブランクに設定) されています。 Windows では、ポインター引き数を far ポインターとして定義する際に FAR が用いられます。

引き数
この項では、各関数実引き数と、そのデータ・タイプ、説明、その引き数が入力引き数と出力引き数のどちらであるかをリストしています。

SQLGetInfo()SQLBindParameter() だけが、入力および出力の両方のパラメーターを持っています。

関数の中には、据え置き またはバインド済み 引き数という入力引き数または出力引き数が含まれているものがあります。

これらの引き数はアプリケーションによって割り当てられたバッファーを指すポインターであり、 SQL ステートメント内のパラメーターか、結果セット内の列に関連付けられ (またはバインドされ) ます。関数で指定したデータ域は、後で DB2 CLI にアクセスされます。 DB2 CLI にアクセスされる時点で、これらの据え置きデータ域がまだ有効であることが重要です。

使用法
この項は、関数の使用法に関する情報と特別な考慮事項を示します。起こる可能性のあるエラー状態についてはここでは説明せず、診断の項にリストしています。

戻りコード
この項では、戻される可能性のあるすべての関数戻りコードをリストします。 SQL_ERROR または SQL_SUCCESS_WITH_INFO が返された場合は、 SQLError() を呼び出してエラー情報を得ることができます。

戻りコードの詳細については、診断を参照してください。

診断
この項には、 DB2 CLI から明示的に返された SQLSTATE (DBMS に生成された SQLSTATE も返されることがある) をリストした表があり、エラーの原因が示されています。この値は、関数が SQL_ERROR または SQL_SUCCESS_WITH_INFO を返した後に SQLError() を呼び出すと得られます。

診断の詳細については、診断を参照してください。

制限
この項は、アプリケーションに影響を与える可能性がある DB2 CLI と ODBC の間の相違点または制限を示します。

この項には、汎用データ・タイプ定義を使用したときの、コード断片、または関数の使用法を示すコード断片への参照のいずれかが含まれています。すべてのコード断片に使用される完全なソースは、 sqllib/samples/cli (または sqllib\samples\cli) ディレクトリー内で使用可能です。組み込まれている例のリストについては、付録 J, CLI サンプル・コードを参照してください。

DB2 CLI 環境のセットアップとサンプル・アプリケーションのアクセスに関する詳細は、 第 4 章, CLI の構成およびサンプル・アプリケーションの実行を参照してください。

参照
この項は、関連する DB2 CLI 関数をリストします。


[ ページのトップ | 前ページ | 次ページ | 目次 | 索引 ]