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

IBytesMessage

バイト・メッセージとは、本体がバイトのストリームからなるメッセージです。

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

関連資料
バイト・メッセージ

.NET プロパティー

.NET プロパティーの要約:
.NET プロパティー 説明
BodyLength メッセージの本体が読み取り専用である場合に、メッセージの本体の長さ (バイト単位) を取得します。

BodyLength – 本体の長さの取得

インターフェース:
Int64 BodyLength
{
get;
}

メッセージの本体が読み取り専用である場合に、メッセージの本体の長さ (バイト単位) を取得します。

この値は、メッセージを読み取るためのカーソルの現在の位置にかかわらず、本体の全体の長さが戻されます。

例外:
  • XMSException
  • MessageNotReadableException

メソッド

メソッドの要約:
メソッド 説明
ReadBoolean バイト・メッセージ・ストリームからブール値を読み取ります。
ReadSignedByte バイト・メッセージ・ストリームから、次のバイトを符号付き 8 ビット整数として読み取ります。
ReadBytes カーソルの現在位置から始まるバイトの配列を、バイト・メッセージ・ストリームから読み取ります。
ReadChar バイト・メッセージ・ストリームから、次の 2 バイトを文字として読み取ります。
ReadDouble バイト・メッセージ・ストリームから、次の 8 バイトを倍精度浮動小数点数として読み取ります。
ReadFloat バイト・メッセージ・ストリームから、次の 4 バイトを浮動小数点数として読み取ります。
ReadInt バイト・メッセージ・ストリームから、次の 4 バイトを符号付き 32 ビット整数として読み取ります。
ReadLong バイト・メッセージ・ストリームから、次の 8 バイトを符号付き 64 ビット整数として読み取ります。
ReadShort バイト・メッセージ・ストリームから、次の 2 バイトを符号付き 16 ビット整数として読み取ります。
ReadByte バイト・メッセージ・ストリームから、次のバイトを符号なし 8 ビット整数として読み取ります。
ReadUnsignedShort バイト・メッセージ・ストリームから、次の 2 バイトを符号なし 16 ビット整数として読み取ります。
ReadUTF バイト・メッセージ・ストリームから、UTF-8 でエンコードされたストリングを読み取ります。
Reset メッセージの本体を読み取り専用モードにして、カーソルをバイト・メッセージ・ストリームの先頭に位置変更します。
WriteBoolean バイト・メッセージ・ストリームへブール値を書き込みます。
WriteByte バイト・メッセージ・ストリームへ 1 バイト書き込みます。
WriteBytes バイト・メッセージ・ストリームへバイトの配列を書き込みます。
WriteBytes 部分的なバイト配列を、指定の長さで定義したとおりにバイト・メッセージ・ストリームに書き込みます。
WriteChar 文字を、上位バイトを先にして、2 バイトでバイト・メッセージ・ストリームに書き込みます。
WriteDouble 倍精度浮動小数点数を長整数に変換し、その長整数を、上位バイトを先にして、8 バイトでバイト・メッセージ・ストリームに書き込みます。
WriteFloat 浮動小数点数を整数に変換し、その整数を、上位バイトを先にして、4 バイトでバイト・メッセージ・ストリームに書き込みます。
WriteInt 整数を、上位バイトを先にして、4 バイトでバイト・メッセージ・ストリームに書き込みます。
WriteLong 長整数を、上位バイトを先にして、8 バイトでバイト・メッセージ・ストリームに書き込みます。
WriteObject 指定したオブジェクトをバイト・メッセージ・ストリームに書き込みます。
WriteShort 短整数を、上位バイトを先にして、2 バイトでバイト・メッセージ・ストリームに書き込みます。
WriteUTF バイト・メッセージ・ストリームへ、UTF-8 でエンコードされたストリングを書き込みます。

ReadBoolean – ブール値の読み取り

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

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

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

ReadSignedByte – バイトの読み取り

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

バイト・メッセージ・ストリームから、次のバイトを符号付き 8 ビット整数として読み取ります。

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

ReadBytes – バイトの読み取り

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

カーソルの現在位置から始まるバイトの配列を、バイト・メッセージ・ストリームから読み取ります。

パラメーター:
array (出力)
読み取られるバイトの配列を含むバッファー。呼び出しの前の、ストリームから読み取られる残りバイト数が、バッファーの長さより大きいか等しい場合、バッファーはいっぱいになります。残りバイト数の方が小さい場合は、バッファーに残りのすべてのバイトが格納され、バッファーは部分的に埋まります。

入力に NULL ポインターを指定すると、メソッドはそのバイトを読み取らずにスキップオーバーします。 呼び出しの前の、ストリームから読み取られる残りバイト数が、バッファーの長さより大きいか等しい場合、スキップされるバイト数は、バッファーの長さと等しくなります。残りバイト数の方が小さい場合、残りのすべてのバイトがスキップされます。

length (入力)
バッファーの長さ (バイト単位)
戻り値:
バッファーに読み取るバイト数。バッファーが部分的に埋まっている場合は、値はバッファーの長さよりも小さく、読み取るバイトが残っていないことを示します。呼び出し前のストリームに読み取られるバイトが残っていない場合、値は XMSC_END_OF_STREAM です。

入力に 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();

バイト・メッセージ・ストリームから、次の 4 バイトを符号付き 32 ビット整数として読み取ります。

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

ReadLong – 長整数の読み取り

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

バイト・メッセージ・ストリームから、次の 8 バイトを符号付き 64 ビット整数として読み取ります。

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

ReadShort – 短整数の読み取り

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

バイト・メッセージ・ストリームから、次の 2 バイトを符号付き 16 ビット整数として読み取ります。

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

ReadByte – 符号なしバイトの読み取り

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

バイト・メッセージ・ストリームから、次のバイトを符号なし 8 ビット整数として読み取ります。

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

ReadUnsignedShort – 符号なし短整数の読み取り

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

バイト・メッセージ・ストリームから、次の 2 バイトを符号なし 16 ビット整数として読み取ります。

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

ReadUTF – UTF ストリングの読み取り

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

バイト・メッセージ・ストリームから、UTF-8 でエンコードされたストリングを読み取ります。

パラメーター:
なし
戻り値:
読み取られるストリングをカプセル化している String オブジェクト。
例外:
  • XMSException
  • MessageNotReadableException
  • MessageEOFException

Reset – リセット

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

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

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

WriteBoolean – ブール値の書き込み

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

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

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

WriteByte – バイトの書き込み

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

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

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

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

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

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

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

WriteBytes – 部分的なバイト配列の書き込み

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

部分的なバイト配列を、指定の長さで定義したとおりにバイト・メッセージ・ストリームに書き込みます。

パラメーター:
value (入力)
書き込まれるバイト配列。
offset (入力)
書き込まれるバイト配列の開始点。
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);

指定したオブジェクトをバイト・メッセージ・ストリームに書き込みます。

パラメーター:
value (入力)
書き込まれるオブジェクト。プリミティブ型への参照である必要があります。
戻り値:
Void
例外:
  • XMSException
  • MessageNotWritableException

WriteShort – 短整数の書き込み

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

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

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

WriteUTF – UTF ストリングの書き込み

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

バイト・メッセージ・ストリームへ、UTF-8 でエンコードされたストリングを書き込みます。

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