WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 作業系統: Linux, Windows

BytesMessage

位元組訊息是一種其主體包含一個位元組串流的訊息。

繼承階層:
xms::PropertyContext
   |
   +----xms::Message
           |
           +----xms::BytesMessage
相關參考
位元組訊息

方法

方法摘要:
方法 說明
getBodyLength 在訊息主體為唯讀時,取得訊息主體的長度。
readBoolean 從位元組訊息串流中讀取 Boolean 值。
readByte 從位元組訊息串流中讀取下一個位元組, 以當成一個帶正負號的 8 位元整數。
readBytes 在位元組訊息串流中,從游標的現行位置開始讀取位元組陣列。
readChar 從位元組訊息串流中讀取下兩個位元組,以當成一個字元。
readDouble 從位元組訊息串流中讀取下 8 個位元組, 以當成一個倍精準度浮點數。
readFloat 從位元組訊息串流中讀取下 4 個位元組, 以當成一個浮點數。
readInt 從位元組訊息串流中讀取下 4 個位元組, 以當成一個帶正負號的 32 位元整數。
readLong 從位元組訊息串流中讀取下 8 個位元組, 以當成一個帶正負號的 64 位元整數。
readShort 從位元組訊息串流中讀取下 2 個位元組, 以當成一個帶正負號的 16 位元整數。
readUnsignedByte 從位元組訊息串流中讀取下一個位元組, 以當成一個不帶正負號的 8 位元整數。
readUnsignedShort 從位元組訊息串流中讀取下 2 個位元組, 以當成一個不帶正負號的 16 位元整數。
readUTF 從位元組訊息串流讀取一個以 UTF-8 編碼的字串。
reset 將訊息主體變成唯讀模式, 並將游標重新定位在位元組訊息串流開頭。
writeBoolean 將 Boolean 值寫入位元組訊息串流中。
writeByte 將位元組寫入位元組訊息串流中。
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 – 讀取 Boolean 值

介面:
xmsBOOL readBoolean() const;

從位元組訊息串流中讀取 Boolean 值。

參數:
傳回:
所讀取的 Boolean 值。
異常狀況:
  • 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(輸出)
內含所讀取之位元組陣列的緩衝區。如果在呼叫前,要從串流中讀取的剩餘位元組數, 大於或等於緩衝區長度,則會填入緩衝區中。否則,緩衝區只是被局部填入所有剩餘的位元組。

如果您在輸入中指定一個空值指標, 則方法會略過位元組而不會讀取。如果在呼叫前,要從串流中讀取的剩餘位元組數, 大於或等於緩衝區的長度,則所略過的位元組數等於緩衝區長度。否則,會略過所有剩餘的位元組。

bufferLength(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會將位元組讀入緩衝區中,但串流中所剩的位元組數(從游標的現行位置算起)會放在 returnedLength 參數中傳回,且游標不會前進。
returnedLength(輸出)
要讀入緩衝區中的位元組數。如果緩衝區只被局部填入, 則其值小於緩衝區長度,這表示已無位元組要讀取。在呼叫前,如果串流中已無留待讀取的位元組, 則其值為 XMSC_END_OF_STREAM

如果您在輸入中指定一個空值指標, 則方法不會傳回任何值。

傳回:
請參閱 returnedLength 參數的說明。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_MESSAGE_NOT_READABLE_EXCEPTION
  • XMS_X_MESSAGE_EOF_EXCEPTION

readChar – 讀取字元

介面:
xmsCHAR16 readChar() const;

從位元組訊息串流中讀取下兩個位元組,以當成一個字元。

參數:
傳回:
所讀取的字元。
異常狀況:
  • 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 – 寫入 Boolean 值

介面:
xmsVOID writeBoolean(const xmsBOOL value);

將 Boolean 值寫入位元組訊息串流中。

參數:
value(輸入)
要寫入的 Boolean 值。
傳回:
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

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

使用條款 | 評比此網頁

時間戳記前次更新: 25 Apr 2006
(C) Copyright IBM Corporation 2005. All Rights Reserved.
本資訊中心採用 Eclipse 技術。(http://www.eclipse.org)