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

對映訊息

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

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

相關參考
對映訊息

函數

函數摘要:
函數 說明
xmsMapMsgGetBoolean 從對映訊息主體中取得名稱所識別的 Boolean 值。
xmsMapMsgGetByte 從對映訊息主體中取得名稱所識別的位元組。
xmsMapMsgGetBytes 從對映訊息主體中取得名稱所識別的位元組陣列。
xmsMapMsgGetBytesByRef 取得對映訊息主體中之位元組陣列的指標, 並取得陣列的長度。
xmsMapMsgGetChar 從對映訊息主體中取得名稱所識別的字元。
xmsMapMsgGetDouble 從對映訊息主體中取得名稱所識別的倍精準度浮點數。
xmsMapMsgGetFloat 從對映訊息主體中取得名稱所識別的浮點數。
xmsMapMsgGetInt 從對映訊息主體中取得名稱所識別的整數。
xmsMapMsgGetLong 從對映訊息主體中取得名稱所識別的長整數。
xmsMapMsgGetMap 取得對映訊息主體中的名稱值組清單。
xmsMapMsgGetObject 從對映訊息主體中取得名稱值組的值與其資料類型。
xmsMapMsgGetShort 從對映訊息主體中取得名稱所識別的短整數。
xmsMapMsgGetString 從對映訊息主體中取得名稱所識別的字串。
xmsMapMsgGetStringByRef 取得指向名稱所識別之字串的指標,以及取得字串的長度。
xmsMapMsgItemExists 檢查對映訊息主體是否含有指定名稱的名稱值組。
xmsMapMsgSetBoolean 在對映訊息主體中設定一個 Boolean 值。
xmsMapMsgSetByte 在對映訊息主體中設定一個位元組。
xmsMapMsgSetBytes 在對映訊息主體中設定一個位元組陣列。
xmsMapMsgSetChar 在對映訊息主體中設定一個二位元組字元。
xmsMapMsgSetDouble 在對映訊息主體中設定一個倍精準度浮點數。
xmsMapMsgSetFloat 在對映訊息主體中設定一個浮點數。
xmsMapMsgSetInt 在對映訊息主體中設定一個整數。
xmsMapMsgSetLong 在對映訊息主體中設定一個長整數。
xmsMapMsgSetObject 在對映訊息主體中設定一個採用指定資料類型的值。
xmsMapMsgSetShort 在對映訊息主體中設定一個短整數。
xmsMapMsgSetString 在對映訊息主體中設定一個字串。

xmsMapMsgGetBoolean – 取得 Boolean 值

介面:
xmsRC xmsMapMsgGetBoolean(xmsHMsg message,
                          xmsCHAR *name,
                          xmsBOOL *value,
                          xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別 Boolean 值的名稱。此名稱採用空值終止字串格式。
value(輸出)
擷取自對映訊息主體的 Boolean 值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetByte – 取得位元組

介面:
xmsRC xmsMapMsgGetByte(xmsHMsg message,
                       xmsCHAR *name,
                       xmsSBYTE *value,
                       xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別位元組的名稱。此名稱採用空值終止字串格式。
value(輸出)
擷取自對映訊息主體的位元組。位元組不會進行任何資料轉換。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetBytes – 取得位元組

介面:
xmsRC xmsMapMsgGetBytes(xmsHMsg message,
                        xmsCHAR *name,
                        xmsSBYTE *buffer,
                        xmsINT bufferLength,
                        xmsINT *actualLength,
                        xmsHErrorBlock errorBlock);

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

如需如何使用此函數的相關資訊, 請參閱會以值形式來傳回位元組陣列的 C 函數

參數:
message(輸入)
訊息的控點。
name(輸入)
識別位元組陣列的名稱。此名稱採用空值終止字串格式。
buffer(輸出)
內含位元組陣列的緩衝區。所傳回的位元組不會進行任何資料轉換。
bufferLength(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回位元組陣列,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
陣列中的位元組數。如果您在輸入中指定一個空值指標, 則不會傳回陣列的長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetBytesByRef – 取得參照形式的位元組

介面:
xmsRC xmsMapMsgGetBytesByRef(xmsHMsg message,
                             xmsCHAR *name,
                             xmsSBYTE **array,
                             xmsINT *length,
                             xmsHErrorBlock errorBlock);

取得對映訊息主體中之位元組陣列的指標, 並取得陣列的長度。位元組陣列是以名稱來識別。

如需如何使用此函數的相關資訊, 請參閱會以參照形式來傳回字串或位元組陣列的 C 函數

參數:
message(輸入)
訊息的控點。
name(輸入)
識別位元組陣列的名稱。此名稱採用空值終止字串格式。
array(輸出)
位元組陣列的指標。
length(輸出)
陣列中的位元組數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetChar – 取得字元

介面:
xmsRC xmsMapMsgGetChar(xmsHMsg message,
                       xmsCHAR *name,
                       xmsCHAR16 *value,
                       xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別字元的名稱。此名稱採用空值終止字串格式。
value(輸出)
擷取自對映訊息主體的字元。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetDouble – 取得倍精準度浮點數

介面:
xmsRC xmsMapMsgGetDouble(xmsHMsg message,
                         xmsCHAR *name,
                         xmsDOUBLE *value,
                         xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別倍精準度浮點數的名稱。此名稱採用空值終止字串格式。
value(輸出)
擷取自對映訊息主體的倍精準度浮點數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetFloat – 取得浮點數

介面:
xmsRC xmsMapMsgGetFloat(xmsHMsg message,
                        xmsCHAR *name,
                        xmsFLOAT *value,
                        xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別浮點數的名稱。此名稱採用空值終止字串格式。
value(輸出)
擷取自對映訊息主體的浮點數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetInt – 取得整數

介面:
xmsRC xmsMapMsgGetInt(xmsHMsg message,
                      xmsCHAR *name,
                      xmsINT *value,
                      xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別整數的名稱。此名稱採用空值終止字串格式。
value(輸出)
擷取自對映訊息主體的整數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetLong – 取得長整數

介面:
xmsRC xmsMapMsgGetLong(xmsHMsg message,
                       xmsCHAR *name,
                       xmsLONG *value,
                       xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別長整數的名稱。此名稱採用空值終止字串格式。
value(輸出)
擷取自對映訊息主體的長整數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetMap – 取得名稱值組

介面:
xmsRC xmsMapMsgGetMap(xmsHMsg message,
                      xmsHIterator *iterator,
                      xmsHErrorBlock errorBlock);

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

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

註: 同等 JMS 方法所執行的功能略有差異。JMS 方法會傳回對映訊息主體中的名稱列舉表(但未包含值)。
參數:
message(輸入)
訊息的控點。
iterator(輸出)
疊代子的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetObject – 取得物件

介面:
xmsRC xmsMapMsgGetObject(xmsHMsg message,
                         xmsCHAR *name,
                         xmsSBYTE *buffer,
                         xmsINT bufferLength,
                         xmsINT *actualLength,
                         xmsOBJECT_TYPE *objectType,
                         xmsHErrorBlock errorBlock);

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

如需如何使用此函數的相關資訊, 請參閱會以值形式來傳回位元組陣列的 C 函數

參數:
message(輸入)
訊息的控點。
name(輸入)
採空值終止字串格式的名稱值組的名稱。
buffer(輸出)
內含值(以位元組陣列形式傳回)的緩衝區。如果值為一個字串而需要轉換資料, 則此為轉換後的值。
bufferLength(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回值,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
值的長度(以位元組計)。如果值為一個字串而需要轉換資料, 則此為轉換後的長度。如果您在輸入中指定一個空值指標, 則不會傳回長度。
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
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetShort – 取得短整數

介面:
xmsRC xmsMapMsgGetShort(xmsHMsg message,
                        xmsCHAR *name,
                        xmsSHORT *value,
                        xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別短整數的名稱。此名稱採用空值終止字串格式。
value(輸出)
擷取自對映訊息主體的短整數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetString – 取得字串

介面:
xmsRC xmsMapMsgGetString(xmsHMsg message,
                         xmsCHAR *name,
                         xmsCHAR *buffer,
                         xmsINT bufferLength,
                         xmsINT *actualLength,
                         xmsHErrorBlock errorBlock);

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

如需如何使用此函數的相關資訊, 請參閱會以值形式來傳回字串的 C 函數

參數:
message(輸入)
訊息的控點。
name(輸入)
識別字串的名稱。此名稱採用空值終止字串格式。
buffer(輸出)
內含字串的緩衝區。如果需要轉換資料, 則此為轉換後的字串。
bufferLength(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回字串,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
字串的長度(以位元組計)。如果需要轉換資料, 則此為轉換後的字串長度。如果您在輸入中指定一個空值指標, 則不會傳回長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgGetStringByRef – 取得參照形式的字串

介面:
xmsRC xmsMapMsgGetStringByRef(xmsHMsg message,
                              xmsCHAR *name,
                              xmsCHAR **string,
                              xmsINT *length,
                              xmsHErrorBlock errorBlock);

取得指向名稱所識別之字串的指標,以及取得字串的長度。

如需如何使用此函數的相關資訊, 請參閱會以參照形式來傳回字串或位元組陣列的 C 函數

參數:
message(輸入)
訊息的控點。
name(輸入)
識別字串的名稱。此名稱採用空值終止字串格式。
string(輸出)
字串的指標。如果需要轉換資料, 則此為轉換後的字串。
length(輸出)
字串的長度(以位元組計)。如果需要轉換資料, 則此為轉換後的長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

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

介面:
xmsRC xmsMapMsgItemExists(xmsHMsg message,
                          xmsCHAR *name,
                          xmsBOOL *pairExists,
                          xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
採空值終止字串格式的名稱值組的名稱。
pairExists(輸出)
如果對映訊息主體含有一個指定名稱的名稱值組,則值為 xmsTRUE。如果對映訊息主體未包含一個指定名稱的名稱值組,則值為 xmsFALSE
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetBoolean – 設定 Boolean 值

介面:
xmsRC xmsMapMsgSetBoolean(xmsHMsg message,
                          xmsCHAR *name,
                          xmsBOOL value,
                          xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之 Boolean 值的名稱。此名稱採用空值終止字串格式。
value(輸入)
要設定的 Boolean 值。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetByte – 設定位元組

介面:
xmsRC xmsMapMsgSetByte(xmsHMsg message,
                       xmsCHAR *name,
                       xmsSBYTE value,
                       xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之位元組的名稱。此名稱採用空值終止字串格式。
value(輸入)
要設定的位元組。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetBytes – 設定多個位元組

介面:
xmsRC xmsMapMsgSetBytes(xmsHMsg message,
                        xmsCHAR *name,
                        xmsSBYTE *value,
                        xmsINT length,
                        xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之位元組陣列的名稱。此名稱採用空值終止字串格式。
value(輸入)
要設定的位元組陣列。
length(輸入)
陣列中的位元組數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetChar – 設定字元

介面:
xmsRC xmsMapMsgSetChar(xmsHMsg message,
                       xmsCHAR *name,
                       xmsCHAR16 value,
                       xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之字元的名稱。此名稱採用空值終止字串格式。
value(輸入)
要設定的字元。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetDouble – 設定倍精準度浮點數

介面:
xmsRC xmsMapMsgSetDouble(xmsHMsg message,
                         xmsCHAR *name,
                         xmsDOUBLE value,
                         xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之倍精準度浮點數的名稱。此名稱採用空值終止字串格式。
value(輸入)
要設定的倍精準度浮點數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetFloat – 設定浮點數

介面:
xmsRC xmsMapMsgSetFloat(xmsHMsg message,
                        xmsCHAR *name,
                        xmsFLOAT value,
                        xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之浮點數的名稱。此名稱採用空值終止字串格式。
value(輸入)
要設定的浮點數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetInt – 設定整數

介面:
xmsRC xmsMapMsgSetInt(xmsHMsg message,
                      xmsCHAR *name,
                      xmsINT value,
                      xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之整數的名稱。此名稱採用空值終止字串格式。
value(輸入)
要設定的整數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetLong – 設定長整數

介面:
xmsRC xmsMapMsgSetLong(xmsHMsg message,
                       xmsCHAR *name,
                       xmsLONG value,
                       xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之長整數的名稱。此名稱採用空值終止字串格式。
value(輸入)
要設定的長整數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetObject – 設定物件

介面:
xmsRC xmsMapMsgSetObject(xmsHMsg message,
                         xmsCHAR *name,
                         xmsSBYTE *value,
                         xmsINT length,
                         xmsOBJECT_TYPE objectType,
                         xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之值的名稱。此名稱採用空值終止字串格式。
value(輸入)
內含所設之值的位元組陣列。
length(輸入)
陣列中的位元組數。
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
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetShort – 設定短整數

介面:
xmsRC xmsMapMsgSetShort(xmsHMsg message,
                        xmsCHAR *name,
                        xmsSHORT value,
                        xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之短整數的名稱。此名稱採用空值終止字串格式。
value(輸入)
要設定的短整數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMapMsgSetString – 設定字串

介面:
xmsRC xmsMapMsgSetString(xmsHMsg message,
                         xmsCHAR *name,
                         xmsCHAR *value,
                         xmsINT length,
                         xmsHErrorBlock errorBlock);

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

參數:
message(輸入)
訊息的控點。
name(輸入)
識別對映訊息主體中之字串的名稱。此名稱採用空值終止字串格式。
value(輸入)
內含所要設定之字串的字元陣列。
length(輸入)
字串的長度(以位元組計)。如果字串在沒有內嵌空值字元下空值終止, 您可以指定 XMSC_CALCULATE_STRING_SIZE,以容許 XMS 計算其長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

使用條款 | 評比此網頁

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