ODBC 関数

Db2® ODBC では、固有の目的、診断、制限を持つ、さまざまな SQL 関連の関数を用意しています。

これらのトピックについて

これらのトピックには、以下のセクションのいずれかが、その他のセクションに加えて含まれている場合があります。 非推奨の関数を取り上げた特定のセクションは省略されています。

目的
この関数が準拠している仕様および規格を示した表が含まれています。

最初の欄は、この関数が ODBC 仕様に含まれているかどうかを示し、さらにその関数の仕様を持つ最初の ODBC バージョン (1.0、2.0、または 3.0) を示しています。 2 番目の欄では、この 関数が X/Open CLI CAE 仕様に含まれているかどうか、さらに 3 番目の欄はこの 関数が ISO CLI 規格に含まれているかどうかを示しています。以下の表は、X/Open CLI CAE 仕様および ISO CLI 規格の両方に含まれる ODBC 3.0 関数の仕様表の一例です。

表 1. 関数仕様表の例
ODBC X/OPEN CLI ISO CLI
3.0 あり あり
構文
この関数の汎用 C 言語プロトタイプが含まれています。

ポインターである関数の引数はすべて、FAR マクロを使用して定義されます。 このマクロは除外定義 (ブランクに設定) されています。これは、ODBC 仕様と整合性があります。

関数の引数
それぞれの関数引数とそのデータ・タイプ、説明、およびそれが入力引数であるか出力引数であるかが示されています。

SQLGetInfo() および SQLBindParameter() のみが、入力および出力の両方のパラメーターを使用します。

関数の中には、据え置き 引数 または バインド済み 引数と呼ばれる入力引数または出力引数 を使用するものがあります。この引数はアプリケーションに割り振られたバッファー を指すポインターであり、SQL ステートメントのパラメーター、もしくは結果セットの列に 関連付けられます (またはバインドされます)。SQL ステートメントを実行する場合、あるいは据え置き引数が バインド済みの結果セットを取り出す場合に、Db2 ODBC はこれらのバッファーをアクセスします。

重要: 入力引数の場合、これらの値を必要とするステートメントを実行する場合は、据え置きデータ域に有効データがあることを確認してください。 出力引数の場合は、結果の取り出しが終わるまで、据え置きデータ域は割り振られたままの状態 にしておいてください。
戻りコード
関数のすべての戻りコードをリストしています。 SQL_ERROR または SQL_SUCCESS_WITH_INFO が戻された場合は、SQLGetDiagRec() を呼び出すことによって、エラー情報を取得することができます。
診断
Db2 ODBC によって明示的に返される SQLSTATE を含み、エラーの原因を示します。 (また、Db2 ODBC は、データベース管理システムが生成する SQLSTATE を戻す可能性もあります。) これらの SQLSTATE の値を取得するには、SQL_ERROR または SQL_SUCCESS_WITH_INFO を戻す関数で、SQLGetDiagRec() を呼び出してください。