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

BytesMessage

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

継承の階層:
xms::PropertyContext
|
+----xms::Message
|
+----xms::BytesMessage
関連資料
バイト・メッセージ

メソッド

メソッドの要約:
メソッド 説明
getBodyLength メッセージの本体が読み取り専用である場合に、メッセージの本体の長さを取得します。
readBoolean バイト・メッセージ・ストリームからブール値を読み取ります。
readByte バイト・メッセージ・ストリームから、次のバイトを符号付き 8 ビット整数として読み取ります。
readBytes カーソルの現在位置から始まるバイトの配列を、バイト・メッセージ・ストリームから読み取ります。
readChar バイト・メッセージ・ストリームから、次の 2 バイトを文字として読み取ります。
readDouble バイト・メッセージ・ストリームから、次の 8 バイトを倍精度浮動小数点数として読み取ります。
readFloat バイト・メッセージ・ストリームから、次の 4 バイトを浮動小数点数として読み取ります。
readInt バイト・メッセージ・ストリームから、次の 4 バイトを符号付き 32 ビット整数として読み取ります。
readLong バイト・メッセージ・ストリームから、次の 8 バイトを符号付き 64 ビット整数として読み取ります。
readShort バイト・メッセージ・ストリームから、次の 2 バイトを符号付き 16 ビット整数として読み取ります。
readUnsignedByte バイト・メッセージ・ストリームから、次のバイトを符号なし 8 ビット整数として読み取ります。
readUnsignedShort バイト・メッセージ・ストリームから、次の 2 バイトを符号なし 16 ビット整数として読み取ります。
readUTF バイト・メッセージ・ストリームから、UTF-8 でエンコードされたストリングを読み取ります。
reset メッセージの本体を読み取り専用モードにして、カーソルをバイト・メッセージ・ストリームの先頭に位置変更します。
writeBoolean バイト・メッセージ・ストリームへブール値を書き込みます。
writeByte バイト・メッセージ・ストリームへ 1 バイト書き込みます。
writeBytes バイト・メッセージ・ストリームへバイトの配列を書き込みます。
writeChar 文字を、上位バイトを先にして、2 バイトでバイト・メッセージ・ストリームに書き込みます。
writeDouble 倍精度浮動小数点数を長整数に変換し、その長整数を、上位バイトを先にして、8 バイトでバイト・メッセージ・ストリームに書き込みます。
writeFloat 浮動小数点数を整数に変換し、その整数を、上位バイトを先にして、4 バイトでバイト・メッセージ・ストリームに書き込みます。
writeInt 整数を、上位バイトを先にして、4 バイトでバイト・メッセージ・ストリームに書き込みます。
writeLong 長整数を、上位バイトを先にして、8 バイトでバイト・メッセージ・ストリームに書き込みます。
writeShort 短整数を、上位バイトを先にして、2 バイトでバイト・メッセージ・ストリームに書き込みます。
writeUTF バイト・メッセージ・ストリームへ、UTF-8 でエンコードされたストリングを書き込みます。

getBodyLength – 本体の長さの取得

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

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

パラメーター:
なし
戻り値:
メッセージの本体の長さ (バイト単位)。このメソッドは、メッセージを読み取るためのカーソルの現在の位置にかかわらず、本体の全体の長さを戻します。
例外:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION

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

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

bufferLength (入力)
バッファーの長さ (バイト単位)。代わりに XMSC_QUERY_SIZE を指定した場合、バッファーにバイトは読み込まれませんが、カーソルの現在位置から始まるストリーム内の残りバイト数が returnedLength パラメーターに戻され、カーソルは先に進みません。
returnedLength (出力)
バッファーに読み取るバイト数。バッファーが部分的に埋まっている場合は、値はバッファーの長さよりも小さく、読み取るバイトが残っていないことを示します。呼び出し前のストリームに読み取られるバイトが残っていない場合、値は XMSC_END_OF_STREAM です。

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

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

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

readLong – 長整数の読み取り

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

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

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

readShort – 短整数の読み取り

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

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

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

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

インターフェース:
xmsBYTE readUnsignedByte() const;

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

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

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

インターフェース:
xmsUSHORT readUnsignedShort() const;

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

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

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

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

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

パラメーター:
なし
戻り値:
読み取られるストリングをカプセル化している 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

writeBoolean – ブール値の書き込み

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

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

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

writeByte – バイトの書き込み

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

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

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

writeShort – 短整数の書き込み

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

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

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

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

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

バイト・メッセージ・ストリームへ、UTF-8 でエンコードされたストリングを書き込みます。必要な場合、XMS がストリング内の文字をローカル・コード・ページから UTF-8 に変換します。

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