cniIsTerminalAttached

ターミナルがコネクターによって他のノードに付加されているかどうかを検査します。 これは、指定したターミナル・オブジェクトが、 他のメッセージ・フロー・ノード上の 1 つ以上のターミナルに付加されているかどうかを示す整数値を戻します。 これは、メッセージをターミナルに伝搬できるかどうかをテストするために使用できます。 ただし、cniPropagate ユーティリティー関数でメッセージを伝搬する前にこの関数を呼び出す必要はありません。 ターミナルが接続されていないときに、cniIsTerminalAttached 関数を使用して、 ノードはその動作を変更することができます。

構文

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

パラメーター

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

戻り値

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

  if (terminalObject) {
        if (cniIsTerminalAttached(&rc, terminalObject)) {
            if (rc == CCI_SUCCESS) {
              retvalue = cniPropagate(
                                                                                                  &rc,
                                                             terminalObject,
                                                             destinationList,
                                                             exceptionList,
                                message);

関連概念
ユーザー定義の入力ノード
ユーザー定義のメッセージ処理ノード
ユーザー定義の出力ノード

関連タスク
C での入力ノードの作成
C でのメッセージ処理ノードの作成

関連資料
C 言語ノード・ユーティリティー関数
cniCreateOutputTerminal
cniPropagate