WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 オペレーティング・システム: Linux, Windows

MapMessage

マップ・メッセージとは、本体が名前と値のペアで構成されるメッセージです。それぞれの値に、関連付けられたデータ型があります。

継承の階層:
xms::PropertyContext
|
+----xms::Message
|
+----xms::MapMessage

アプリケーションが名前と値のペアの値を取得するとき、値は XMS によって別のデータ型に変換される可能性があります。この形式の暗黙の型変換について詳しくは、マップ・メッセージを参照してください。

関連資料
マップ・メッセージ

メソッド

メソッドの要約:
メソッド 説明
getBoolean マップ・メッセージの本体から名前で識別されるブール値を取得します。
getByte マップ・メッセージの本体から名前で識別されるバイトを取得します。
getBytes マップ・メッセージの本体から名前で識別されるバイトの配列を取得します。
getChar マップ・メッセージの本体から名前で識別される文字を取得します。
getDouble マップ・メッセージの本体から名前で識別される倍精度浮動小数点数を取得します。
getFloat マップ・メッセージの本体から名前で識別される浮動小数点数を取得します。
getInt マップ・メッセージの本体から名前で識別される整数を取得します。
getLong マップ・メッセージの本体から名前で識別される長整数を取得します。
getMap マップ・メッセージの本体の名前と値のペアのリストを取得します。
getObject マップ・メッセージの本体から、名前と値のペアの値と、そのデータ型を取得します。
getShort マップ・メッセージの本体から名前で識別される短整数を取得します。
getString マップ・メッセージの本体から名前で識別されるストリングを取得します。
itemExists マップ・メッセージの本体に、指定した名前が付けられた名前と値のペアが含まれているかどうかをチェックします。
setBoolean マップ・メッセージの本体にブール値を設定します。
setByte マップ・メッセージの本体にバイトを設定します。
setBytes マップ・メッセージの本体にバイトの配列を設定します。
setChar マップ・メッセージの本体に 2 バイト文字を設定します。
setDouble マップ・メッセージの本体に倍精度浮動小数点数を設定します。
setFloat マップ・メッセージの本体に浮動小数点数を設定します。
setInt マップ・メッセージの本体に整数を設定します。
setLong マップ・メッセージの本体に長整数を設定します。
setObject マップ・メッセージの本体に、指定されたデータ型の値を設定します。
setShort マップ・メッセージの本体に短整数を設定します。
setString マップ・メッセージの本体にストリングを設定します。

getBoolean – ブール値の取得

インターフェース:
xmsBOOL getBoolean(const String & name) const;

マップ・メッセージの本体から名前で識別されるブール値を取得します。

パラメーター:
name (入力)
ブール値を識別する名前をカプセル化している String オブジェクト。
戻り値:
マップ・メッセージの本体から検索されたブール値。
例外:
  • XMS_X_GENERAL_EXCEPTION

getByte – バイトの取得

インターフェース:
xmsSBYTE getByte(const String & name) const;

マップ・メッセージの本体から名前で識別されるバイトを取得します。

パラメーター:
name (入力)
バイトを識別する名前をカプセル化している String オブジェクト。
戻り値:
マップ・メッセージの本体から検索されたバイト。バイトにはデータ変換は実行されません。
例外:
  • XMS_X_GENERAL_EXCEPTION

getBytes – 複数バイトの取得

インターフェース:
xmsINT getBytes(const String & name,
xmsSBYTE *buffer,
const xmsINT bufferLength,
xmsINT *actualLength) const;

マップ・メッセージの本体から名前で識別されるバイトの配列を取得します。

このメソッドの使用方法について詳しくは、バイト配列を戻す C++ メソッドを参照してください。

パラメーター:
name (入力)
バイトの配列を識別する名前をカプセル化している String オブジェクト。
buffer (出力)
バイトの配列を含むバッファー。戻されるバイトにはデータ変換は実行されません。
bufferLength (入力)
バッファーの長さ (バイト単位)。代わりに XMSC_QUERY_SIZE を指定すると、バイトの配列は戻されませんが、actualLength パラメーターでバイトの配列の長さが戻されます。
actualLength (出力)
配列のバイト数。入力に NULL ポインターを指定すると、配列の長さが戻されません。
戻り値:
配列のバイト数。
例外:
  • XMS_X_GENERAL_EXCEPTION

getChar – 文字の取得

インターフェース:
xmsCHAR16 getChar(const String & name) const;

マップ・メッセージの本体から名前で識別される文字を取得します。

パラメーター:
name (入力)
文字を識別する名前をカプセル化している String オブジェクト。
戻り値:
マップ・メッセージの本体から検索された文字。
例外:
  • XMS_X_GENERAL_EXCEPTION

getDouble – 倍精度浮動小数点数の取得

インターフェース:
xmsDOUBLE getDouble(const String & name) const;

マップ・メッセージの本体から名前で識別される倍精度浮動小数点数を取得します。

パラメーター:
name (入力)
倍精度浮動小数点数を識別する名前をカプセル化している String オブジェクト。
戻り値:
マップ・メッセージの本体から検索された倍精度浮動小数点数。
例外:
  • XMS_X_GENERAL_EXCEPTION

getFloat – 浮動小数点数の取得

インターフェース:
xmsFLOAT getFloat(const String & name) const;

マップ・メッセージの本体から名前で識別される浮動小数点数を取得します。

パラメーター:
name (入力)
浮動小数点数を識別する名前をカプセル化している String オブジェクト。
戻り値:
マップ・メッセージの本体から検索された浮動小数点数。
例外:
  • XMS_X_GENERAL_EXCEPTION

getInt – 整数の取得

インターフェース:
xmsINT getInt(const String & name) const;

マップ・メッセージの本体から名前で識別される整数を取得します。

パラメーター:
name (入力)
整数を識別する名前をカプセル化している String オブジェクト。
戻り値:
マップ・メッセージの本体から検索された整数。
例外:
  • XMS_X_GENERAL_EXCEPTION

getLong – 長整数の取得

インターフェース:
xmsLONG getLong(const String & name) const;

マップ・メッセージの本体から名前で識別される長整数を取得します。

パラメーター:
name (入力)
長整数を識別する名前をカプセル化している String オブジェクト。
戻り値:
マップ・メッセージの本体から検索された長整数。
例外:
  • XMS_X_GENERAL_EXCEPTION

getMap – 名前と値のペアの取得

インターフェース:
Iterator getMap() const;

マップ・メッセージの本体の名前と値のペアのリストを取得します。

このメソッドは、Property オブジェクトのリストをカプセル化するイテレーターを戻します。各 Property オブジェクトは、名前と値のペアをカプセル化しています。アプリケーションは、そのイテレーターを使用して、名前と値のペアのそれぞれに順番にアクセスすることができます。

注: 同等の JMS メソッドでは、多少異なる働きをします。JMS メソッドでは、マップ・メッセージの本体にある名前のみを列挙した形で戻し、値は戻しません。
パラメーター:
なし
戻り値:
Iterator オブジェクト。
例外:
  • XMS_X_GENERAL_EXCEPTION

getObject – オブジェクトの取得

インターフェース:
xmsOBJECT_TYPE getObject(const String & name,
xmsSBYTE *buffer,
const xmsINT bufferLength,
xmsINT *actualLength) const;

マップ・メッセージの本体から、名前と値のペアの値と、そのデータ型を取得します。名前と値のペアは、名前で識別されます。

このメソッドの使用方法について詳しくは、バイト配列を戻す C++ メソッドを参照してください。

パラメーター:
name (入力)
名前と値のペアの名前をカプセル化している String オブジェクト。
buffer (出力)
バイトの配列として戻される値を含むバッファー。 値がストリングでデータ変換が必要な場合、これは変換後の値です。
bufferLength (入力)
バッファーの長さ (バイト単位)。その代わりに XMSC_QUERY_SIZE を指定すると、値は戻されませんが、actualLength パラメーターで値の長さが戻されます。
actualLength (出力)
値の長さ (バイト単位)。値がストリングでデータ変換が必要な場合、これは変換後の長さです。入力に NULL ポインターを指定すると、長さが戻されません。
戻り値:
値のデータ型。以下のオブジェクト・タイプのいずれかです。
  • XMS_OBJECT_TYPE_BOOL
  • XMS_OBJECT_TYPE_BYTE
  • XMS_OBJECT_TYPE_BYTEARRAY
  • XMS_OBJECT_TYPE_CHAR
  • XMS_OBJECT_TYPE_DOUBLE
  • XMS_OBJECT_TYPE_FLOAT
  • XMS_OBJECT_TYPE_INT
  • XMS_OBJECT_TYPE_LONG
  • XMS_OBJECT_TYPE_SHORT
  • XMS_OBJECT_TYPE_STRING
例外:
XMS_X_GENERAL_EXCEPTION

getShort – 短整数の取得

インターフェース:
xmsSHORT getShort(const String & name) const;

マップ・メッセージの本体から名前で識別される短整数を取得します。

パラメーター:
name (入力)
短整数を識別する名前をカプセル化している String オブジェクト。
戻り値:
マップ・メッセージの本体から検索された短整数。
例外:
  • XMS_X_GENERAL_EXCEPTION

getString – ストリングの取得

インターフェース:
String getString(const String & name) const;

マップ・メッセージの本体から名前で識別されるストリングを取得します。

パラメーター:
name (入力)
マップ・メッセージの本体のストリングを識別する名前をカプセル化している String オブジェクト。
戻り値:
マップ・メッセージの本体から取り出したストリングをカプセル化している String オブジェクト。データ変換が必要な場合、これは変換後のストリングです。
例外:
  • XMS_X_GENERAL_EXCEPTION

itemExists – 名前と値のペアの存在のチェック

インターフェース:
xmsBOOL itemExists(const String & name) const;

マップ・メッセージの本体に、指定した名前が付けられた名前と値のペアが含まれているかどうかをチェックします。

パラメーター:
name (入力)
名前と値のペアの名前をカプセル化している String オブジェクト。
戻り値:
  • マップ・メッセージの本体に、指定された名前が付けられた名前と値のペアが含まれている場合は、xmsTRUE です。
  • マップ・メッセージの本体に、指定された名前が付けられた名前と値のペアが含まれていない場合は、xmsFALSE です。
例外:
  • XMS_X_GENERAL_EXCEPTION

setBoolean – ブール値の設定

インターフェース:
xmsVOID setBoolean(const String & name,
const xmsBOOL value);

マップ・メッセージの本体にブール値を設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在するブール値を識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定されるブール値。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setByte – バイトの設定

インターフェース:
xmsVOID setByte(const String & name,
const xmsSBYTE value);

マップ・メッセージの本体にバイトを設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在するバイトを識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定されるバイト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setBytes – 複数バイトの設定

インターフェース:
xmsVOID setBytes(const String & name,
const xmsSBYTE *value,
const xmsINT length);

マップ・メッセージの本体にバイトの配列を設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在するバイトの配列を識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定されるバイト配列。
length (入力)
配列のバイト数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setChar – 文字の設定

インターフェース:
xmsVOID setChar(const String & name,
const xmsCHAR16 value);

マップ・メッセージの本体に 2 バイト文字を設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在する文字を識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定される文字。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setDouble – 倍精度浮動小数点数の設定

インターフェース:
xmsVOID setDouble(const String & name,
const xmsDOUBLE value);

マップ・メッセージの本体に倍精度浮動小数点数を設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在する倍精度浮動小数点数を識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定される倍精度浮動小数点数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setFloat – 浮動小数点数の設定

インターフェース:
xmsVOID setFloat(const String & name,
const xmsFLOAT value);

マップ・メッセージの本体に浮動小数点数を設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在する浮動小数点数を識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定される浮動小数点数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setInt – 整数の設定

インターフェース:
xmsVOID setInt(const String & name,
const xmsINT value);

マップ・メッセージの本体に整数を設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在する整数を識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定される整数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setLong – 長整数の設定

インターフェース:
xmsVOID setLong(const String & name,
const xmsLONG value);

マップ・メッセージの本体に長整数を設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在する長整数を識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定される長整数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setObject – オブジェクトの設定

インターフェース:
xmsVOID setObject(const String & name,
const xmsOBJECT_TYPE objectType,
const xmsSBYTE *value,
const xmsINT length);

マップ・メッセージの本体に、指定されたデータ型の値を設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在する値を識別するための名前をカプセル化している String オブジェクト。
objectType (入力)
値のデータ型。以下のオブジェクト・タイプのいずれかでなければなりません。
  • XMS_OBJECT_TYPE_BOOL
  • XMS_OBJECT_TYPE_BYTE
  • XMS_OBJECT_TYPE_BYTEARRAY
  • XMS_OBJECT_TYPE_CHAR
  • XMS_OBJECT_TYPE_DOUBLE
  • XMS_OBJECT_TYPE_FLOAT
  • XMS_OBJECT_TYPE_INT
  • XMS_OBJECT_TYPE_LONG
  • XMS_OBJECT_TYPE_SHORT
  • XMS_OBJECT_TYPE_STRING
value (入力)
設定される値を含むバイトの配列。
length (入力)
配列のバイト数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setShort – 短整数の設定

インターフェース:
xmsVOID setShort(const String & name,
const xmsSHORT value);

マップ・メッセージの本体に短整数を設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在する短整数を識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定される短整数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

setString – ストリングの設定

インターフェース:
xmsVOID setString(const String & name,
const String value);

マップ・メッセージの本体にストリングを設定します。

パラメーター:
name (入力)
マップ・メッセージの本体に存在するストリングを識別するための名前をカプセル化している String オブジェクト。
value (入力)
設定されるストリングをカプセル化している String オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION

継承されたメソッド


Reference topic

ご利用条件 | フィードバック (英語のみ)

Timestamp icon最終更新: 8 Jun 2006
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。(http://www.eclipse.org)