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

IStreamMessage

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

継承の階層:
IBM.XMS.IPropertyContext
|
+----IBM.XMS.IMessage
|
+----IBM.XMS.IStreamMessage

アプリケーションがメッセージ・ストリームから値を読み取るとき、値は 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 – ブール値の読み取り

インターフェース:
Boolean ReadBoolean();

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

パラメーター:
なし
戻り値:
読み取られるブール値。
例外:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadByte – バイトの読み取り

インターフェース:
Int16 ReadSignedByte();
Byte ReadByte();

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

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

ReadBytes – バイトの読み取り

インターフェース:
Int32 ReadBytes(Byte[] array);

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

パラメーター:
array (入力)
読み取られるバイトの配列が収容されているバッファーとそのバッファーの長さ (単位: バイト)。

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

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

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

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

例外:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadChar – 文字の読み取り

インターフェース:
Char ReadChar();

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

パラメーター:
なし
戻り値:
読み取られる文字。
例外:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

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

インターフェース:
Double ReadDouble();

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

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

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

インターフェース:
Single ReadFloat();

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

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

ReadInt – 整数の読み取り

インターフェース:
Int32 ReadInt();

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

パラメーター:
なし
戻り値:
読み取られる整数。
例外:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

ReadLong – 長整数の読み取り

インターフェース:
Int64 ReadLong();

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

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

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

インターフェース:
Object ReadObject();

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

パラメーター:
なし
戻り値:
値。以下のオブジェクト・タイプのいずれかです。
  • Boolean
  • Byte
  • Byte[]
  • Char
  • Double
  • Single
  • Int32
  • Int64
  • Int16
  • String
例外:
XMSException

ReadShort – 短整数の読み取り

インターフェース:
Int16 ReadShort();

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

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

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

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

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

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

Reset – リセット

インターフェース:
void Reset();

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

パラメーター:
なし
戻り値:
void
例外:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

WriteBoolean – ブール値の書き込み

インターフェース:
void WriteBoolean(Boolean value);

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

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

WriteByte – バイトの書き込み

インターフェース:
void WriteByte(Byte value);
void WriteSignedByte(Int16 value);

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

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

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

インターフェース:
void WriteBytes(Byte[] value);

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

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

WriteChar – 文字の書き込み

インターフェース:
void WriteChar(Char value);

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

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

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

インターフェース:
void WriteDouble(Double value);

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

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

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

インターフェース:
void WriteFloat(Single value);

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

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

WriteInt – 整数の書き込み

インターフェース:
void WriteInt(Int32 value);

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

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

WriteLong – 長整数の書き込み

インターフェース:
void WriteLong(Int64 value);

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

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

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

インターフェース:
void WriteObject(Object value);

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

パラメーター:
objectType (入力)
値。以下のオブジェクト・タイプのいずれかでなければなりません。
  • Boolean
  • Byte
  • Byte[]
  • Char
  • Double
  • Single
  • Int32
  • Int64
  • Int16
  • String
value (入力)
書き込まれる値を含むバイトの配列。
length (入力)
配列のバイト数。
戻り値:
void
例外:
  • XMSException

WriteShort – 短整数の書き込み

インターフェース:
void WriteShort(Int16 value);

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

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

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

インターフェース:
void WriteString(String value);

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

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

継承されたプロパティーおよびメソッド


Reference topic

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

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