WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 オペレーティング・システム: Linux, Windows

ErrorBlock

C 関数呼び出しが失敗した場合、XMS は呼び出しの失敗の原因に関する情報をエラー・ブロックに保管することができます。

エラー・ブロックおよびその内容について詳しくは、エラー・ブロックを参照してください。

このクラスの関数は、以下の戻りコードを戻します。
戻りコード 意味
XMS_OK 呼び出しが正しく完了しました。
XMS_E_INVALID_ERROR_BLOCK 関数に渡されたエラー・ブロックが無効であったため、呼び出しは失敗しました。
その他の値 別の何らかの理由で呼び出しが失敗しました。

これはヘルパー・クラスです。

関数

関数の要約:
関数 説明
xmsErrorClear エラー・ブロックの内容をクリアします。
xmsErrorCreate エラー・ブロックを作成します。
xmsErrorDispose エラー・ブロックを削除します。
xmsErrorGetErrorCode エラー・コードを取得します。
xmsErrorGetErrorData エラー・データを取得します。
xmsErrorGetErrorString エラー・ストリングを取得します。
xmsErrorGetJMSException 例外コードを取得します。
xmsErrorGetLinkedError エラー・ブロックのチェーン内の次のエラー・ブロックのハンドルを取得します。

xmsErrorClear – エラー・ブロックのクリア

インターフェース:
xmsRC xmsErrorClear(xmsHErrorBlock errorBlock);

エラー・ブロックの内容をクリアします。

XMS は、API ファンクション呼び出しによって渡されたエラー・ブロックの内容を自動的にクリアします。

パラメーター:
errorBlock (入力)
エラー・ブロックのハンドル。
スレッド・コンテキスト:
任意

xmsErrorCreate – エラー・ブロックの作成

インターフェース:
xmsRC xmsErrorCreate(xmsHErrorBlock *errorBlock);

エラー・ブロックを作成します。

新規に作成されたエラー・ブロックでは、例外コードは XMS_X_NO_EXCEPTION です。

パラメーター:
errorBlock (出力)
エラー・ブロックのハンドル。
スレッド・コンテキスト:
任意

xmsErrorDispose – エラー・ブロックの削除

インターフェース:
xmsRC xmsErrorDispose(xmsHErrorBlock *errorBlock);

エラー・ブロックを削除します。

エラー・ブロックのチェーン内の最初のエラー・ブロックのみを、明示的に削除できます。チェーン内の最初のエラー・ブロックを削除すると、チェーン内の後続のエラー・ブロックもすべて削除されます。

アプリケーションが、既に削除されているエラー・ブロックを削除しようとした場合、呼び出しは無視されます。

パラメーター:
errorBlock (入出力)
入力では、エラー・ブロックのハンドル。出力で、関数は NULL ハンドルを戻します。
スレッド・コンテキスト:
任意

xmsErrorGetErrorCode – エラー・コードの取得

インターフェース:
xmsRC xmsErrorGetErrorCode(xmsHErrorBlock errorBlock,
xmsINT *errorCode);

エラー・コードを取得します。

エラー・コードについて詳しくは、エラー・ブロックを参照してください。

パラメーター:
errorBlock (入力)
エラー・ブロックのハンドル。
errorCode (出力)
エラー・コード。
スレッド・コンテキスト:
任意

xmsErrorGetErrorData – エラー・データの取得

インターフェース:
xmsRC xmsErrorGetErrorData(xmsHErrorBlock errorBlock,
xmsCHAR *buffer,
xmsINT bufferLength,
xmsINT *actualLength);

エラー・データを取得します。

エラー・データについて詳しくは、エラー・ブロックを参照してください。

この関数の使用方法について詳しくは、値によりストリングを戻す C 関数を参照してください。

パラメーター:
errorBlock (入力)
エラー・ブロックのハンドル。
buffer (出力)
エラー・データを含むバッファー。
bufferLength (入力)
バッファーの長さ (バイト単位)。代わりに XMSC_QUERY_SIZE を指定すると、エラー・データは戻されずに、actualLength パラメーターにエラー・データの長さが戻されます。
actualLength (出力)
エラー・データの長さ (バイト単位)。入力に NULL ポインターを指定すると、長さが戻されません。
スレッド・コンテキスト:
任意

xmsErrorGetErrorString – エラー・ストリングの取得

インターフェース:
xmsRC xmsErrorGetErrorString(xmsHErrorBlock errorBlock,
xmsCHAR *buffer,
xmsINT bufferLength,
xmsINT *actualLength);

エラー・ストリングを取得します。

エラー・ストリングについて詳しくは、エラー・ブロックを参照してください。

この関数の使用方法について詳しくは、値によりストリングを戻す C 関数を参照してください。

パラメーター:
errorBlock (入力)
エラー・ブロックのハンドル。
buffer (出力)
エラー・ストリングを含むバッファー。
bufferLength (入力)
バッファーの長さ (バイト単位)。代わりに XMSC_QUERY_SIZE を指定すると、エラー・ストリングは戻されずに、actualLength パラメーターにエラー・ストリングの長さが戻されます。
actualLength (出力)
エラー・ストリングの長さ (バイト単位)。入力に NULL ポインターを指定すると、長さが戻されません。
スレッド・コンテキスト:
任意

xmsErrorGetJMSException – 例外コードの取得

インターフェース:
xmsRC xmsErrorGetJMSException(xmsHErrorBlock errorBlock,
xmsJMSEXP_TYPE *exceptionCode);

例外コードを取得します。

例外コードについて詳しくは、エラー・ブロックを参照してください。

パラメーター:
errorBlock (入力)
エラー・ブロックのハンドル。
exceptionCode (出力)
例外コード。エラー・ブロックが、エラー・ブロックのチェーン内に存在するが、チェーン内の先頭ではない場合、例外コードは常に XMS_X_GENERAL_EXCEPTION です。
スレッド・コンテキスト:
任意

xmsErrorGetLinkedError – リンクされたエラーの取得

インターフェース:
xmsRC xmsErrorGetLinkedError(xmsHErrorBlock errorBlock,
xmsHErrorBlock *linkedError);

エラー・ブロックのチェーン内の次のエラー・ブロックのハンドルを取得します。

パラメーター:
errorBlock (入力)
エラー・ブロックのハンドル。
linkedError (出力)
チェーン内の次のエラー・ブロックのハンドル。チェーン内に次のエラー・ブロックがない場合、関数は NULL ハンドルを戻します。
スレッド・コンテキスト:
任意

Reference topic

ご利用条件 | フィードバック (英語のみ)

Timestamp icon最終更新: 8 Jun 2006
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。(http://www.eclipse.org)