WebSphere Message Broker バージョン 8.0.0.5 オペレーティング・システム: AIX、HP-Itanium、Linux、Solaris、Windows、z/OS

製品の最新バージョンについては、IBM Integration Bus バージョン 9.0 をご覧ください。

cpiElementName

この関数は、ターゲット構文エレメントの名前を取得します。 この構文エレメント名は、cniSetElementName または cpiSetElementName を使用して事前に設定する必要があります。

構文

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

パラメーター

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

戻り値

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

サンプル

cpiElementName(&rc;, element, (CciChar*)&elementName;, sizeof(elementName));
特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック

Copyright IBM Corporation 1999, 2014Copyright IBM Corporation 1999, 2014.

        
        最終更新:
        
        最終更新: 2015-02-28 17:48:08


参照トピック参照トピック | バージョン 8.0.0.5 | as08430_