Db2 for i CLI 関数
これらの Db2 for i コール・レベル・インターフェース API は、IBM i オペレーティング・システム上のデータベース・アクセスで利用可能です。 各 Db2 for i CLI 関数の説明は、一貫性のある形式で表示されます。
関数のカテゴリー・リストについては、 Db2 for i CLI のカテゴリーを参照してください。
CLI 関数の説明方法
以下の表は、関数の説明の各項に記載している情報タイプを示しています。
| タイプ | 説明 |
|---|---|
| 目的 | この項では、該当関数の機能を簡単に概説します。 また、 説明中の関数を呼び出す前後に呼び出す必要のある関数についても説明します。 |
| 構文 | このセクションでは、 IBM i 環境の C 言語プロトタイプについて説明します。 |
| 引数 | この項では、それぞれの関数の引数、そのデータ・タイプ、
説明、および入力引数か出力引数かをリストします。 各 Db2 for i CLI 引数は、入力引数または出力引数のいずれかです。 関数によっては、 据え置き 引数またはバインド 引数として知られる入力引数または出力引数を持つものもあります。 これらの引数は、 アプリケーションで割り振られているバッファーへのポインターになっています。 これらの引数は、SQL ステートメントのパラメーター、 または結果セットの列に関連 (またはバインド) しています。 関数によって指定されたデータ域は、後で Db2 for i CLI によってアクセスされます。 これらの据え置きデータ域は、 Db2 for i CLI がそれらにアクセスする時点でも有効であることが重要です。 |
| 使用法 | この項では、該当関数を使用する方法、 および特殊な考慮事項などの情報を示します。 推定エラー状態についてはこの項では説明しませんが、 その代わりに診断セクションでリストにして示されています。 |
| 戻りコード | この項には、有効な関数戻りコードがすべてリストされます。 SQL_ERROR または SQL_SUCCESS_WITH_INFO が戻された場合、
リターンコードの詳細については、 Db2 for i CLIアプリケーションの診断を参照してください。 |
| 診断 | このセクションには、 Db2 for i CLI によって明示的に戻される SQLSTATE (データベース管理システム (DBMS) によって生成される SQLSTATE も戻される場合がある) をリストし、エラーの原因を示す表が含まれています。 該当関数から SQL_ERROR または SQL_SUCCESS_WITH_INFO が戻された後で 最初の列の * は、SQLSTATE が Db2 for i CLI によってのみ戻され、他の ODBC ドライバーによって戻されないことを示します。 診断の詳細については、 Db2 for i CLI アプリケーションの診断を参照してください。 |
| 制約事項 | このセクションでは、アプリケーションに影響を与える可能性がある Db2 for i CLI と ODBC の相違点または制限事項について説明します。 |
| 例 | この項は、該当関数の使用法の実例を示すコーディングの一部となっています。 すべてのコード フラグメントに使用される完全なソースは、「例: Db2 for i CLI アプリケーション」 にリストされています。 |
| 参照 | このセクションでは、関連する Db2 for i CLI 関数をリストします。 |