cniGetAttributeName

索引ごとに指定されたノード属性の名前を戻します。 これは、ノードの特定のインスタンスによってサポートされる属性の名前が必要な際に、 メッセージ・ブローカーによって呼び出されます。 この関数は、既知の定義された順序で属性を戻し、 索引パラメーターによって表される属性名を戻すことを保証しなければなりません。

定義されている場所 タイプ メンバー
CNI_VFT オプション iFpGetAttributeName

構文

int cniGetAttributeName(
    CciContext* context,
    int          index,
    CciChar*    buffer,
  int          bufsize);

パラメーター

context
ノードによって作成され、cniCreateNodeContext 関数によって戻される、 ノードのインスタンスのコンテキストのアドレス (入力)。
index
属性名の索引を指定します (入力)。 属性の索引は、ゼロから始まります。
buffer
属性名のコピー先のバッファーのアドレス (出力)。
bufsize
buffer パラメーターで指定した、バイト単位のバッファーの長さ (入力)。

戻り値

正常に実行されると、ゼロが戻され、 指定したバッファーに属性の名前が戻されます。 属性のリストの末尾に達すると、非ゼロ値が戻されます。

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

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

関連資料
C 言語ノード・インプリメンテーション関数
cniCreateNodeContext
cniGetAttribute