各関数の説明は、以下のセクションで構成されています。
- 目的
- このセクションでは、関数によって何が行われるかを概説します。また、説明対象の関数を
呼び出す前および後に、なんらかの関数を呼び出す必要があるかどうかにつ
いても示します。
各関数には、その関数がどの仕様または標準に準拠しているかを示す表も備
わっています。
この表は、関数のサポートを示します。一部の関数では、すべての仕様または標準
には適用されないようなオプションのセットを使用します。重要な相違点が
あれば、関数の制約事項のところで明記します。
- 構文
- このセクションには、汎用 'C' プロトタイプが含まれています。汎用プロトタイプは
、Windows を含むすべての環境で使用されます。
ポインターである関数の引き数はすべて、マクロ FAR を使用して定義
されます。このマクロは、Windows を除くすべてのプラットフォームの場合、
ブランクに設定されます。Windows では、FAR は、ポインター引き数
を far ポインターとして定義するために使用されます。
- 引き数
- このセクションでは、関数の各引き数をリストアップし、その引き数に関するデー
タ・タイプ、説明のほか、入力引き数であるか出力引き数であるかの区別も示
します。
関数によっては、据え置き 引き数またはバインド 引き数と呼ばれる入力引き数または出力引き数を含んでいます。
これらの引き数はアプリケーションが割り当てるバッファーへの
ポインターであり、SQL ステートメント内のパラメーター、または結果セット内の
列のいずれかに関連付け (またはバインド) されます。
関数が指定したデータ域は、後から DB2 CLI によってアクセスされます。
これらの据え置きデータ域は、DB2 CLI によってアクセスさ
れた時点でも、引き続き有効なままでなければなりません。
- 使用法
- このセクションでは、関数の使用法に関して説明するとともに、特殊な
考慮事項を示します。起こり得るエラー条件については、ここではなく、診断のセクションに
リストされています。
- 戻りコード
- このセクションでは、関数について発生し得るすべての戻りコードをリストアップしています。SQL_ERROR または SQL_SUCCESS_WITH_INFO が
戻された場合、エラー情報は、SQLError() または SQLGetDiagRec() を
呼び出すことによって入手できます。
- 診断
- このセクションには、DB2 CLI によって明示的に戻される SQLSTATE (DBMS によって
生成される SQLSTATE も戻される場合があります) をリストアップするとと
もに、エラーの原因を示す
表が含まれています。これらの値は、関数が SQL_ERROR または SQL_SUCCESS_WITH_INFO を
戻した後で、SQLError() または SQLGetDiagRec() を
呼び出すことによって入手できます。
- 制約事項
- このセクションでは、アプリケーションに影響を与える可能性がある
、DB2 Everyplace CLI と ODBC の相違点または制限を示します。
戻りコード、診断、例、CLI 環境の設定、およびサンプル・アプリケーションへのアクセスについての情報を含めた、 DB2 CLI の詳細情報については、「IBM DB2 Universal Database コール・レベル・インターフェースの手引きおよび解説書」を参照してください。
関連した解説