SQLError() - エラー情報を取り出す
SQLError() は使用すべきでない関数です。これは SQLGetRiagRec() に置き換えられます。
SQLError() の ODBC 仕様
| ODBC 仕様レベル | X/Open CLI CAE 仕様 | ISO CLI 仕様 |
|---|---|---|
| 1.0 (「使用すべきでない」) | あり | あり |
構文
SQLRETURN SQLError (SQLHENV henv,
SQLHDBC hdbc,
SQLHSTMT hstmt,
SQLCHAR FAR *szSqlState,
SQLINTEGER FAR *pfNativeError,
SQLCHAR FAR *szErrorMsg,
SQLSMALLINT cbErrorMsgMax,
SQLSMALLINT FAR *pcbErrorMsg);
関数の引数
次の表は、この関数のそれぞれの引数ごとに、 データ・タイプ、用途、および説明を示しています。
| データ・タイプ | 引数 | 使用法 | 説明 |
|---|---|---|---|
| SQLHENV | henv | 入力 | 環境ハンドル。 環境に関連した診断情報を取得するためには、有効な環境ハンドルを渡してください。 hdbc を SQL_NULL_HDBC に設定し、hstmt を SQL_NULL_HSTMT に設定してください。 |
| SQLHDBC | hdbc | 入力 | データベース接続ハンドル。 接続に関連した診断情報を取得するためには、有効なデータベース接続ハンドル を渡し、hstmt を SQL_NULL_HSTMT に設定してください。引数 henv は無視されます。 |
| SQLHSTMT | hstmt | 入力 | ステートメント・ハンドル。 ステートメントに関連した診断情報を取得するためには、有効な ステートメント・ハンドルを渡してください。 引数 henv と引数 hdbc は無視されます。 |
| SQLCHAR * | szSqlState | 出力 | NULL 文字で終了している 5 文字のストリングの SQLSTATE。 最初の 2 文字はエラー・クラスを示し、次の 3 文字はサブクラスを示します。 これらの値は、X/Open SQL CAE 仕様と ODBC 仕様で定義されている SQLSTATE 値 に直接的に対応しており、IBM® 固有と製品固有の SQLSTATE 値が 追加されています。 |
| SQLINTEGER * | pfNativeError | 出力 | 固有のエラー・コード。 Db2® ODBC では、引数 pfNativeError にデータベース管理システムから 戻された SQLCODE 値が入ります。エラーがデータベース管理システムではなく Db2 ODBC で生成された場合、このフィールドは -99999 に設定されます。 |
| SQLCHAR * | szErrorMsg | 出力 | インプリメンテーションで定義されたメッセージ・テキストを入れる
バッファーを指すポインター。
エラーが Db2 ODBC によって検出された場合、エラー・メッセージの前に
以下のものが付けられます。
上記のメッセージの前につけた文字列は、Db2 ODBC がエラーを検出し、データベースへの接続はまだ行われて
いないことを示しています。エラー・ロケーション (ERRLOC x:y:z) のキーワード値もバッファーに入れられます。 これは、診断用の内部エラー・コードです。 データベースの接続中にエラーが検出されると、データベース管理システムから
戻されるエラー・メッセージの前に以下のものが付けられます。
DBMS-name は、SQL_DBMS_NAME 情報タイプを指定した SQLGetInfo() が戻す名前です。例えば、次のとおりです。
Vendor は、IBM 以外の DRDA データベース管理システムを示します。 データベース管理システムによってエラーが生成される場合は、IBM 定義の SQLSTATE がテキスト・ストリング に付加されます。 |
| SQLSMALLINT | cbErrorMsgMax | 入力 | バッファー szErrorMsg のバイトで表した最大長 (つまり、割り振られた長さ)。 割り振る場合の推奨される長さは、SQL_MAX_MESSAGE_LENGTH + 1 です。 |
| SQLSMALLINT * | pcbErrorMsg | 出力 | szErrorMsg バッファーに戻すために使用できる総バイト数を 指すポインター。 これには、NUL 終止符は含まれていません。 |