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

StreamMessage

ストリーム・メッセージとは、本体が値のストリームで構成されるメッセージです。それぞれの値に、関連付けられたデータ型があります。

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

本体の内容は、順番に読み書きされます。

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

関連資料
ストリーム・メッセージ

メソッド

メソッドの要約:
メソッド 説明
readBoolean メッセージ・ストリームからブール値を読み取ります。
readByte メッセージ・ストリームから符号付き 8 ビット整数を読み取ります。
readBytes メッセージ・ストリームからバイトの配列を読み取ります。
readChar メッセージ・ストリームから 2 バイト文字を読み取ります。
readDouble メッセージ・ストリームから 8 バイトの倍精度浮動小数点数を読み取ります。
readFloat メッセージ・ストリームから 4 バイトの浮動小数点数を読み取ります。
readInt メッセージ・ストリームから符号付き 32 ビット整数を読み取ります。
readLong メッセージ・ストリームから符号付き 64 ビット整数を読み取ります。
readObject メッセージ・ストリームから値を読み取り、そのデータ型を戻します。
readShort メッセージ・ストリームから符号付き 16 ビット整数を読み取ります。
readString メッセージ・ストリームからストリングを読み取ります。
reset メッセージの本体を読み取り専用モードにして、カーソルをメッセージ・ストリームの先頭に位置変更します。
writeBoolean メッセージ・ストリームへブール値を書き込みます。
writeByte メッセージ・ストリームへバイトを書き込みます。
writeBytes メッセージ・ストリームへバイトの配列を書き込みます。
writeChar 文字を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。
writeDouble 倍精度浮動小数点数を長整数に変換し、その長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。
writeFloat 浮動小数点数を整数に変換し、その整数を、上位バイトを先にして、4 バイトでメッセージ・ストリームに書き込みます。
writeInt 整数を、上位バイトを先にして、4 バイトでメッセージ・ストリームに書き込みます。
writeLong 長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。
writeObject メッセージ・ストリームに、指定されたデータ型の値を書き込みます。
writeShort 短整数を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。
writeString メッセージ・ストリームへストリングを書き込みます。

readBoolean – ブール値の読み取り

インターフェース:
xmsBOOL readBoolean() const;

メッセージ・ストリームからブール値を読み取ります。

パラメーター:
なし
戻り値:
読み取られるブール値。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readByte – バイトの読み取り

インターフェース:
xmsSBYTE readByte() const;

メッセージ・ストリームから符号付き 8 ビット整数を読み取ります。

パラメーター:
なし
戻り値:
読み取られるバイト。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readBytes – バイトの読み取り

インターフェース:
xmsINT readBytes(xmsSBYTE *buffer,
const xmsINT bufferLength,
xmsINT *returnedLength) const;

メッセージ・ストリームからバイトの配列を読み取ります。

パラメーター:
buffer (出力)
読み取られるバイトの配列を含むバッファー。

配列のバイト数が、バッファーの長さ以下である場合は、配列全体がバッファーに読み取られます。配列のバイト数がバッファーの長さを超える場合、配列の一部でバッファーはいっぱいになり、内部カーソルは次に読み取られるバイトの位置をマークします。 次に readBytes() を呼び出すと、カーソルの現在位置から始まる配列から、バイトが読み取られます。

入力に NULL ポインターを指定すると、呼び出しではそのバイトの配列は読み取られずにスキップオーバーされます。

bufferLength (入力)
バッファーの長さ (バイト単位)。
returnedLength (出力)
バッファーに読み取るバイト数。バッファーが部分的に埋まっている場合は、値はバッファーの長さよりも小さく、配列内に読み取るバイトが残っていないことを示します。呼び出し前の配列に読み取り可能なバイトが残っていない場合、値は XMSC_END_OF_BYTEARRAY です。

入力に NULL ポインターを指定すると、メソッドは値を戻しません。

戻り値:
returnedLength パラメーターの説明を参照してください。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readChar – 文字の読み取り

インターフェース:
xmsCHAR16 readChar() const;

メッセージ・ストリームから 2 バイト文字を読み取ります。

パラメーター:
なし
戻り値:
読み取られる文字。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readDouble – 倍精度浮動小数点数の読み取り

インターフェース:
xmsDOUBLE readDouble() const;

メッセージ・ストリームから 8 バイトの倍精度浮動小数点数を読み取ります。

パラメーター:
なし
戻り値:
読み取られる倍精度浮動小数点数。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readFloat – 浮動小数点数の読み取り

インターフェース:
xmsFLOAT readFloat() const;

メッセージ・ストリームから 4 バイトの浮動小数点数を読み取ります。

パラメーター:
なし
戻り値:
読み取られる浮動小数点数。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readInt – 整数の読み取り

インターフェース:
xmsINT readInt() const;

メッセージ・ストリームから符号付き 32 ビット整数を読み取ります。

パラメーター:
なし
戻り値:
読み取られる整数。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readLong – 長整数の読み取り

インターフェース:
xmsLONG readLong() const;

メッセージ・ストリームから符号付き 64 ビット整数を読み取ります。

パラメーター:
なし
戻り値:
読み取られる長整数。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readObject – オブジェクトの読み取り

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

メッセージ・ストリームから値を読み取り、そのデータ型を戻します。

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

パラメーター:
buffer (出力)
バイトの配列として戻される値を含むバッファー。 値がストリングでデータ変換が必要な場合、これは変換後の値です。

入力に NULL ポインターを指定すると、呼び出しはその値を読み取らずにスキップします。

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

readShort – 短整数の読み取り

インターフェース:
xmsSHORT readShort() const;

メッセージ・ストリームから符号付き 16 ビット整数を読み取ります。

パラメーター:
なし
戻り値:
読み取られる短整数。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readString – ストリングの読み取り

インターフェース:
String readString() const;

メッセージ・ストリームからストリングを読み取ります。必要な場合、XMS がストリング内の文字をローカル・コード・ページに変換します。

パラメーター:
なし
戻り値:
読み取られるストリングをカプセル化している String オブジェクト。データ変換が必要な場合、これは変換後のストリングです。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

reset – リセット

インターフェース:
xmsVOID reset() const;

メッセージの本体を読み取り専用モードにして、カーソルをメッセージ・ストリームの先頭に位置変更します。

パラメーター:
なし
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

writeBoolean – ブール値の書き込み

インターフェース:
xmsVOID writeBoolean(const xmsBOOL value);

メッセージ・ストリームへブール値を書き込みます。

パラメーター:
value (入力)
書き込まれるブール値。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

writeByte – バイトの書き込み

インターフェース:
xmsVOID writeByte(const xmsSBYTE value);

メッセージ・ストリームへバイトを書き込みます。

パラメーター:
value (入力)
書き込まれるバイト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

writeBytes – 複数バイトの書き込み

インターフェース:
xmsVOID writeBytes(const xmsSBYTE *value,
const xmsINT length);

メッセージ・ストリームへバイトの配列を書き込みます。

パラメーター:
value (入力)
書き込まれるバイト配列。
length (入力)
配列のバイト数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

writeChar – 文字の書き込み

インターフェース:
xmsVOID writeChar(const xmsCHAR16 value);

文字を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。

パラメーター:
value (入力)
書き込まれる文字。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

writeDouble – 倍精度浮動小数点数の書き込み

インターフェース:
xmsVOID writeDouble(const xmsDOUBLE value);

倍精度浮動小数点数を長整数に変換し、その長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。

パラメーター:
value (入力)
書き込まれる倍精度浮動小数点数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

writeFloat – 浮動小数点数の書き込み

インターフェース:
xmsVOID writeFloat(const xmsFLOAT value);

浮動小数点数を整数に変換し、その整数を、上位バイトを先にして、4 バイトでメッセージ・ストリームに書き込みます。

パラメーター:
value (入力)
書き込まれる浮動小数点数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

writeInt – 整数の書き込み

インターフェース:
xmsVOID writeInt(const xmsINT value);

整数を、上位バイトを先にして、4 バイトでメッセージ・ストリームに書き込みます。

パラメーター:
value (入力)
書き込まれる整数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

writeLong – 長整数の書き込み

インターフェース:
xmsVOID writeLong(const xmsLONG value);

長整数を、上位バイトを先にして、8 バイトでメッセージ・ストリームに書き込みます。

パラメーター:
value (入力)
書き込まれる長整数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

writeObject – オブジェクトの書き込み

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

メッセージ・ストリームに、指定されたデータ型の値を書き込みます。

パラメーター:
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

writeShort – 短整数の書き込み

インターフェース:
xmsVOID writeShort(const xmsSHORT value);

短整数を、上位バイトを先にして、2 バイトでメッセージ・ストリームに書き込みます。

パラメーター:
value (入力)
書き込まれる短整数。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

writeString – ストリングの書き込み

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

メッセージ・ストリームへストリングを書き込みます。

パラメーター:
value (入力)
書き込まれるストリングをカプセル化している String オブジェクト。
戻り値:
Void
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_WRITABLE_EXCEPTION

継承されたメソッド


Reference topic

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

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