マップ・メッセージとは、本体が名前と値のペアで構成されるメッセージです。それぞれの値に、関連付けられたデータ型があります。
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 | マップ・メッセージの本体にストリングを設定します。 |
xmsINT getBytes(const String & name, xmsSBYTE *buffer, const xmsINT bufferLength, xmsINT *actualLength) const;
マップ・メッセージの本体から名前で識別されるバイトの配列を取得します。
このメソッドの使用方法について詳しくは、バイト配列を戻す C++ メソッドを参照してください。
Iterator getMap() const;
マップ・メッセージの本体の名前と値のペアのリストを取得します。
このメソッドは、Property オブジェクトのリストをカプセル化するイテレーターを戻します。各 Property オブジェクトは、名前と値のペアをカプセル化しています。アプリケーションは、そのイテレーターを使用して、名前と値のペアのそれぞれに順番にアクセスすることができます。
xmsOBJECT_TYPE getObject(const String & name, xmsSBYTE *buffer, const xmsINT bufferLength, xmsINT *actualLength) const;
マップ・メッセージの本体から、名前と値のペアの値と、そのデータ型を取得します。名前と値のペアは、名前で識別されます。
このメソッドの使用方法について詳しくは、バイト配列を戻す C++ メソッドを参照してください。
xmsBOOL itemExists(const String & name) const;
マップ・メッセージの本体に、指定した名前が付けられた名前と値のペアが含まれているかどうかをチェックします。
xmsVOID setObject(const String & name, const xmsOBJECT_TYPE objectType, const xmsSBYTE *value, const xmsINT length);
マップ・メッセージの本体に、指定されたデータ型の値を設定します。