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

MapMessage

對映訊息是一種其主體包含一組名稱值組(其中每一個值都有一個相關聯的資料類型)的訊息。

繼承階層:
xms::PropertyContext
   |
   +----xms::Message
           |
           +----xms::MapMessage

當應用程式取得名稱值組的值時,該值可由 XMS 轉換成另一種資料類型。如需這種隱含轉換形式的相關資訊,請參閱對映訊息

相關參考
對映訊息

方法

方法摘要:
方法 說明
getBoolean 從對映訊息主體中取得名稱所識別的 Boolean 值。
getByte 從對映訊息主體中取得名稱所識別的位元組。
getBytes 從對映訊息主體中取得名稱所識別的位元組陣列。
getChar 從對映訊息主體中取得名稱所識別的字元。
getDouble 從對映訊息主體中取得名稱所識別的倍精準度浮點數。
getFloat 從對映訊息主體中取得名稱所識別的浮點數。
getInt 從對映訊息主體中取得名稱所識別的整數。
getLong 從對映訊息主體中取得名稱所識別的長整數。
getMap 取得對映訊息主體中的名稱值組清單。
getObject 從對映訊息主體中取得名稱值組的值與其資料類型。
getShort 從對映訊息主體中取得名稱所識別的短整數。
getString 從對映訊息主體中取得名稱所識別的字串。
itemExists 檢查對映訊息主體是否含有指定名稱的名稱值組。
setBoolean 在對映訊息主體中設定一個 Boolean 值。
setByte 在對映訊息主體中設定一個位元組。
setBytes 在對映訊息主體中設定一個位元組陣列。
setChar 在對映訊息主體中設定一個二位元組字元。
setDouble 在對映訊息主體中設定一個倍精準度浮點數。
setFloat 在對映訊息主體中設定一個浮點數。
setInt 在對映訊息主體中設定一個整數。
setLong 在對映訊息主體中設定一個長整數。
setObject 在對映訊息主體中設定一個採用指定資料類型的值。
setShort 在對映訊息主體中設定一個短整數。
setString 在對映訊息主體中設定一個字串。

getBoolean – 取得 Boolean 值

介面:
xmsBOOL getBoolean(const String & name) const;

從對映訊息主體中取得名稱所識別的 Boolean 值。

參數:
name(輸入)
封裝 Boolean 值識別名稱的 String 物件。
傳回:
擷取自對映訊息主體的 Boolean 值。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getByte – 取得位元組

介面:
xmsSBYTE getByte(const String & name) const;

從對映訊息主體中取得名稱所識別的位元組。

參數:
name(輸入)
封裝位元組識別名稱的 String 物件。
傳回:
擷取自對映訊息主體的位元組。位元組不會進行任何資料轉換。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getBytes – 取得位元組

介面:
xmsINT getBytes(const String & name,
                xmsSBYTE *buffer,
                const xmsINT bufferLength,
                xmsINT *actualLength) const;

從對映訊息主體中取得名稱所識別的位元組陣列。

有關此方法用法的詳細資訊, 請參閱會傳回位元組陣列的 C++ 方法

參數:
name(輸入)
封裝位元組陣列識別名稱的 String 物件。
buffer(輸出)
內含位元組陣列的緩衝區。所傳回的位元組不會進行任何資料轉換。
bufferLength(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回位元組陣列,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
陣列中的位元組數。如果您在輸入中指定一個空值指標, 則不會傳回陣列的長度。
傳回:
陣列中的位元組數。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getChar – 取得字元

介面:
xmsCHAR16 getChar(const String & name) const;

從對映訊息主體中取得名稱所識別的字元。

參數:
name (輸入)
封裝字元識別名稱的 String 物件。
傳回:
擷取自對映訊息主體的字元。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getDouble – 取得倍精準度浮點數

介面:
xmsDOUBLE getDouble(const String & name) const;

從對映訊息主體中取得名稱所識別的倍精準度浮點數。

參數:
name(輸入)
封裝倍精準度浮點數識別名稱的 String 物件。
傳回:
擷取自對映訊息主體的倍精準度浮點數。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getFloat – 取得浮點數

介面:
xmsFLOAT getFloat(const String & name) const;

從對映訊息主體中取得名稱所識別的浮點數。

參數:
name(輸入)
封裝浮點數識別名稱的 String 物件。
傳回:
擷取自對映訊息主體的浮點數。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getInt – 取得整數

介面:
xmsINT getInt(const String & name) const;

從對映訊息主體中取得名稱所識別的整數。

參數:
name(輸入)
封裝整數識別名稱的 String 物件。
傳回:
擷取自對映訊息主體的整數。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getLong – 取得長整數

介面:
xmsLONG getLong(const String & name) const;

從對映訊息主體中取得名稱所識別的長整數。

參數:
name(輸入)
封裝長整數識別名稱的 String 物件。
傳回:
擷取自對映訊息主體的長整數。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getMap – 取得名稱值組

介面:
Iterator getMap() const;

取得對映訊息主體中的名稱值組清單。

此方法會傳回一個封裝 Properties 物件清單的疊代子, 其中,每一個 Properties 物件各封裝一個名稱值組。如此一來, 應用程式可使用疊代子依序存取每一個名稱值組。

註: 同等 JMS 方法所執行的功能略有差異。JMS 方法會傳回對映訊息主體中的名稱列舉表(沒有)。
參數:
傳回:
Iterator 物件。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getObject – 取得物件

介面:
xmsOBJECT_TYPE getObject(const String & name,
                         xmsSBYTE *buffer,
                         const xmsINT bufferLength,
                         xmsINT *actualLength) const;

從對映訊息主體中取得名稱值組的值與其資料類型。名稱值組是以名稱來識別。

有關此方法用法的詳細資訊, 請參閱會傳回位元組陣列的 C++ 方法

參數:
name(輸入)
封裝名稱值組名稱的 String 物件。
buffer(輸出)
內含值(以位元組陣列形式傳回)的緩衝區。如果值為一個字串而需要轉換資料, 則此為轉換後的值。
bufferLength(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回值,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
值的長度(以位元組計)。如果值為一個字串而需要轉換資料, 則此為轉換後的長度。如果您在輸入中指定一個空值指標, 則不會傳回長度。
傳回:
值的資料類型,可為下列一種物件類型:
  • 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

getShort – 取得短整數

介面:
xmsSHORT getShort(const String & name) const;

從對映訊息主體中取得名稱所識別的短整數。

參數:
name(輸入)
封裝短整數識別名稱的 String 物件。
傳回:
擷取自對映訊息主體的短整數。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getString – 取得字串

介面:
String getString(const String & name) const;

從對映訊息主體中取得名稱所識別的字串。

參數:
name(輸入)
封裝對映訊息主體中之字串識別名稱的 String 物件。
傳回:
封裝擷取自對映訊息主體中之字串的 String 物件。如果需要轉換資料, 則此為轉換後的字串。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

itemExists – 檢查名稱值組是否存在

介面:
xmsBOOL itemExists(const String & name) const;

檢查對映訊息主體是否含有指定名稱的名稱值組。

參數:
name(輸入)
封裝名稱值組名稱的 String 物件。
傳回:
  • 如果對映訊息主體含有一個指定名稱的名稱值組,則為 xmsTRUE
  • 如果對映訊息主體不含一個指定名稱的名稱值組,則為 xmsFALSE
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setBoolean – 設定 Boolean 值

介面:
xmsVOID setBoolean(const String & name,
                   const xmsBOOL value);

在對映訊息主體中設定一個 Boolean 值。

參數:
name(輸入)
封裝對映訊息主體中之 Boolean 值識別名稱的 String 物件。
value(輸入)
要設定的 Boolean 值。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setByte – 設定位元組

介面:
xmsVOID setByte(const String & name,
                const xmsSBYTE value);

在對映訊息主體中設定一個位元組。

參數:
name(輸入)
封裝對映訊息主體中之位元組識別名稱的 String 物件。
value(輸入)
要設定的位元組。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setBytes – 設定多個位元組

介面:
xmsVOID setBytes(const String & name,
                 const xmsSBYTE *value,
                 const xmsINT length);

在對映訊息主體中設定一個位元組陣列。

參數:
name(輸入)
封裝對映訊息主體中之位元組陣列識別名稱的 String 物件。
value(輸入)
要設定的位元組陣列。
length(輸入)
陣列中的位元組數。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setChar – 設定字元

介面:
xmsVOID setChar(const String & name,
                const xmsCHAR16 value);

在對映訊息主體中設定一個二位元組字元。

參數:
name(輸入)
封裝對映訊息主體中之字元識別名稱的 String 物件。
value(輸入)
要設定的字元。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setDouble – 設定倍精準度浮點數

介面:
xmsVOID setDouble(const String & name,
                  const xmsDOUBLE value);

在對映訊息主體中設定一個倍精準度浮點數。

參數:
name(輸入)
封裝對映訊息主體中之倍精準度浮點數識別名稱的 String 物件。
value(輸入)
要設定的倍精準度浮點數。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setFloat – 設定浮點數

介面:
xmsVOID setFloat(const String & name,
                 const xmsFLOAT value);

在對映訊息主體中設定一個浮點數。

參數:
name(輸入)
封裝對映訊息主體中之浮點數識別名稱的 String 物件。
value(輸入)
要設定的浮點數。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setInt – 設定整數

介面:
xmsVOID setInt(const String & name,
               const xmsINT value);

在對映訊息主體中設定一個整數。

參數:
name(輸入)
封裝對映訊息主體中之整數識別名稱的 String 物件。
value(輸入)
要設定的整數。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setLong – 設定長整數

介面:
xmsVOID setLong(const String & name,
                const xmsLONG value);

在對映訊息主體中設定一個長整數。

參數:
name(輸入)
封裝對映訊息主體中之長整數識別名稱的 String 物件。
value(輸入)
要設定的長整數。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setObject – 設定物件

介面:
xmsVOID setObject(const String & name,
                  const xmsOBJECT_TYPE objectType,
                  const xmsSBYTE *value,
                  const xmsINT length);

在對映訊息主體中設定一個採用指定資料類型的值。

參數:
name(輸入)
封裝對映訊息主體中之值識別名稱的 String 物件。
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

setShort – 設定短整數

介面:
xmsVOID setShort(const String & name,
                 const xmsSHORT value);

在對映訊息主體中設定一個短整數。

參數:
name(輸入)
封裝對映訊息主體中之短整數識別名稱的 String 物件。
value(輸入)
要設定的短整數。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

setString – 設定字串

介面:
xmsVOID setString(const String & name,
                  const String value);

在對映訊息主體中設定一個字串。

參數:
name(輸入)
封裝對映訊息主體中之字串識別名稱的 String 物件。
value(輸入)
封裝所要設定之字串的 String 物件。
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

繼承的方法


Reference topic

使用條款 | 評比此網頁

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