cpiElementName

目的

ターゲット構文エレメントの名前を取得します。 この構文エレメント名は、cniSetElementName または cpiSetElementName を使用して事前に設定されています。

構文

Ccisize           cpiElementName(
  int*            returnCode,
  CciElement*     targetElement),
  const CciChar*  value,
  CciSize         length);

パラメーター

returnCode
関数からの戻りコードを受け取ります (出力)。
targetElement
ターゲットの構文エレメント・オブジェクトのアドレスを指定します (入力)。
value
構文名のコピー先のバッファーのアドレスを指定します (入力)。
length
value パラメーターで指定される、文字単位の長さ (入力)。

戻り値

正常に実行されると、提供されるバッファーにエレメント名がコピーされ、 コピーされた CciChar 文字の数が戻されます。 バッファーの大きさが不十分でエレメント名を含めることができない場合、 returnCode は CCI_BUFFER_TOO_SMALL に設定され、必要な文字数が戻されます。 その他の障害が発生した場合、CCI_FAILURE が戻され、returnCode がエラーの理由を示します。

サンプル

cpiElementName(&rc;, element, (CciChar*)&elementName;, sizeof(elementName));

関連概念
ユーザー定義のパーサー
ユーザー定義拡張機能

関連タスク
C でのパーサーの作成

関連資料
cpiElementType
cpiElementValue グループ
cpiElementValueValue
パーサー・ユーティリティー関数