cniIsTerminalAttached

ターミナルがコネクターによって他のノードに付加されているかどうかを検査します。 これは、指定したターミナル・オブジェクトが、 他のメッセージ・フロー・ノード上の 1 つ以上のターミナルに付加されているかどうかを示す整数値を戻します。

この関数を使用して、メッセージがターミナルに伝搬されるかどうかテストします。ただし、cniPropagate ユーティリティー関数でメッセージを伝搬する前にこの関数を呼び出す必要はありません。ターミナルが接続されていないときに、cniIsTerminalAttached 関数を使用して、ノードの動作を変更することができます。

構文

int cniIsTerminalAttached(
  int*          returnCode,
  CciTerminal*  terminalObject);

パラメーター

returnCode
関数からの戻りコード (出力)。
考えられる戻りコードは以下のとおりです。
  • CCI_SUCCESS
  • CCI_EXCEPTION
  • CCI_INV_TERMINAL_OBJECT
terminalObject
付加されているコネクターについて検査する入力または出力ターミナルのアドレス (入力)。 このアドレスは、cniCreateOutputTerminal から戻されます。

戻り値

  • ターミナルがコネクターによって他のノードに付加されている場合には、値 1 が戻されます。
  • ターミナルが付加されていない場合、または障害が発生した場合には、値 0 が戻されます。
  • 障害が発生した場合には、returnCode パラメーターの値がエラーの理由を示します。

  if (terminalObject) {
    if (cniIsTerminalAttached(&rc, terminalObject)) {
      if (rc == CCI_SUCCESS) {
        retvalue = cniPropagate(
                                &rc,
                                terminalObject,
                                localEnvironment,
                                exceptionList,
                                message);
特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック

Copyright IBM Corporation 1999, 2009Copyright IBM Corporation 1999, 2009.
最終更新 : 2009-02-20 12:44:34

as07550_