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

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

cpiElementValue グループ

この関数のグループは、指定した構文エレメントの値を検索します。

検索するデータのタイプに一致する適切な関数をこのグループから指定します。

構文

CciSize cpiElementBitArrayValue(
  int*         returnCode,
  CciElement*  targetElement,
  const struct CciBitArray* value);
CciBool cpiElementBooleanValue(
  int*         returnCode,
  CciElement*  targetElement);
CciSize cpiElementByteArrayValue(
  int*         returnCode,
  CciElement*  targetElement,
  const struct CciByteArray* value);
CciSize cpiElementCharacterValue(
  int*            returnCode,
  CciElement*     targetElement,
  const CciChar*  value,
  CciSize         length);
struct CciDate cpiElementDateValue(
  int*         returnCode,
  CciElement*  targetElement);
CciSize cpiElementDecimalValue(
  int*            returnCode,
  CciElement*     targetElement,
  const CciChar*  value,
  CciSize         length);
struct CciTimestamp cpiElementGmtTimestampValue(
  int*         returnCode,
  CciElement*  targetElement);
struct CciTime cpiElementGmtTimeValue(
  int*         returnCode,
  CciElement*  targetElement);
CciInt cpiElementIntegerValue(
  int*         returnCode,
  CciElement*  targetElement);
CciReal cpiElementRealValue(
  int*         returnCode,
  CciElement*  targetElement);
struct CciTimestamp cpiElementTimestampValue(
  int*         returnCode,
  CciElement*  targetElement);
struct CciTime cpiElementTimeValue(
  int*         returnCode,
  CciElement*  targetElement);

パラメーター

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 パラメーターで指定される、文字単位の出力バッファーの長さ (入力)。 関係のある関数呼び出しにのみ使用されます。

戻り値

エレメントの値が戻されます。

場合によっては、バッファーの大きさが不十分でデータを受け取れない場合、このデータはバッファーに書き込まれません。 必要なバッファーのサイズが戻り値として渡され、returnCode は CCI_BUFFER_TOO_SMALL に設定されます。 例えば、cpiElementCharacterValue または cpiElementDecimalValue などでこの技法を使用します。

エラーが発生した場合、returnCode がエラーの理由を示します。

特記事項 | 商標 | ダウンロード | ライブラリー | サポート | フィードバック

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

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


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