cniFinalize

ブローカーが、 ファイナライズ機能をサポートするパーサーを要求して、 指定したメッセージに対してそのファイナライズ処理を実行するようにします。 この処理の動作は、それぞれのパーサーに固有です。

options パラメーターが CCI_FINALIZE_VALIDATE に設定されている場合、 パーサーは妥当性検査処理も実行して、 それが所有するエレメント・ツリーが正しい構造であることを確認する必要があります。 これは、正しく形成されていないエレメント・ツリーのメッセージが、 メッセージ・フローの他のノードに伝搬されないようにするために役立ちます。

メッセージの伝搬の前 (例えば、cniWriteBuffer を呼び出す前) に cniFinalize を呼び出すことをお勧めします。

構文

void cniFinalize(
  int* returnCode,
  CciMessage* message,
  int options);

パラメーター

returnCode
関数からの戻りコード (出力)。
考えられる戻りコードは以下のとおりです。
  • CCI_SUCCESS
  • CCI_EXCEPTION
  • CCI_INV_MESSAGE_OBJECT
message
エレメント・ツリーをファイナライズさせるメッセージ・オブジェクトのアドレス (入力)。
options
使用されるファイナライズまたは妥当性検査オプションを識別するためのビット・フラグを指定します (入力)。 このパラメーターはオプションです。これを CCI_FINALIZE_VALIDATE に設定することも可能です。

戻り値

なし。エラーが発生した場合、returnCode パラメーターがエラーの理由を示します。

      cniFinalize(&rc, outMsg, CCI_FINALIZE_NONE);
      retvalue = cniPropagate(
                             &rc,
                             terminalObject,
                             destinationList,
                             exceptionList,
                             outMsg);

      /* Handle errors */
特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック
Copyright IBM Corporation 1999, 2006 最終更新: 08/21/2006
as07590_