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

Message

Message 物件代表應用程式所傳送或接收的一則訊息。

有關 Message 物件中的 JMS 訊息標頭欄位清單,請參閱XMS 訊息中的標頭欄位。有關 JMS 所定義的 Message 物件內容清單, 請參閱JMS 定義的訊息內容。有關 IBM 所定義的 Message 物件內容清單,請參閱IBM 定義的訊息內容

相關參考
XMS 訊息

函數

函數摘要:
函數 說明
xmsMsgAcknowledge 確認此訊息以及階段作業所收到的所有先前未確認的訊息。
xmsMsgClearBody 清除訊息的主體。
xmsMsgClearProperties 清除訊息的內容。
xmsMsgDispose 刪除訊息。
xmsMsgGetJMSCorrelationID 取得訊息的相互關係 ID。
xmsMsgGetJMSDeliveryMode 取得訊息的遞送模式。
xmsMsgGetJMSDestination 取得訊息的目的地。
xmsMsgGetJMSExpiration 取得訊息的有效期限。
xmsMsgGetJMSMessageID 取得訊息的訊息 ID。
xmsMsgGetJMSPriority 取得訊息的優先順序。
xmsMsgGetJMSRedelivered 取得訊息是否正在重新遞送的指示。
xmsMsgGetJMSReplyTo 取得訊息回覆將送往的目的地。
xmsMsgGetJMSTimestamp 取得訊息的傳送時間。
xmsMsgGetJMSType 取得訊息的類型。
xmsMsgGetProperties 取得訊息的內容清單。
xmsMsgGetTypeId 取得訊息的主體類型。
xmsMsgPropertyExists 檢查訊息是否含有一個指定名稱的內容。
xmsMsgSetJMSCorrelationID 設定訊息的相互關係 ID。
xmsMsgSetJMSDeliveryMode 設定訊息的遞送模式。
xmsMsgSetJMSDestination 設定訊息的目的地。
xmsMsgSetJMSExpiration 設定訊息的有效期限。
xmsMsgSetJMSMessageID 設定訊息的訊息 ID。
xmsMsgSetJMSPriority 設定訊息的優先順序。
xmsMsgSetJMSRedelivered 指出訊息是否正在重新遞送。
xmsMsgSetJMSReplyTo 設定訊息回覆將送往的目的地。
xmsMsgSetJMSTimestamp 設定訊息的傳送時間。
xmsMsgSetJMSType 設定訊息的類型。

xmsMsgAcknowledge – 確認

介面:
xmsRC xmsMsgAcknowledge(xmsHMsg message,
                        xmsHErrorBlock errorBlock);

確認此訊息以及階段作業所收到的所有先前未確認的訊息。

如果階段作業的確認模式為 XMSC_CLIENT_ACKNOWLEDGE, 則應用程式可呼叫這個函數。如果階段作業具有其他任何的確認模式或者為交易式, 則會忽略函數的呼叫。

已收到但未確認的訊息可能會重新遞送。

如需確認訊息的相關資訊, 請參閱在階段作業中確認收到訊息

參數:
message(輸入)
訊息的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION
  • XMS_X_ILLEGAL_STATE_EXCEPTION

xmsMsgClearBody – 清除主體

介面:
xmsRC xmsMsgClearBody(xmsHMsg message,
                      xmsHErrorBlock errorBlock);

清除訊息的主體。標頭欄位和訊息內容不會清除。

如果應用程式清除訊息主體, 該主體所處的狀態和新建訊息中的空主體一樣。新建訊息中之空主體的狀態視訊息主體的類型而定。如果需要詳細資訊,請參閱XMS 訊息的主體

不論訊息主體處於何種狀態, 應用程式隨時都可以將它清除。如果訊息主體為唯讀, 應用程式唯一能寫入主體的方法是先清除主體。

參數:
message(輸入)
訊息的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgClearProperties – 清除內容

介面:
xmsRC xmsMsgClearProperties(xmsHMsg message,
                            xmsHErrorBlock errorBlock);

清除訊息的內容。標頭欄位和訊息主體不會清除。

如果應用程式清除訊息的內容, 則內容即變成可讀寫。

不論訊息內容處於何種狀態, 應用程式隨時都可以將它清除。如果訊息內容為唯讀, 唯一可將內容變成可寫入的方法是先讓應用程式清除內容。

參數:
message(輸入)
訊息的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgDispose – 刪除訊息

介面:
xmsRC xmsMsgDispose(xmsHMsg *message,
                    xmsHErrorBlock errorBlock);

刪除訊息。

如果應用程式試著刪除已刪除的訊息, 則會忽略該呼叫。

參數:
message(輸入)
在輸入方面,為訊息的控點。在輸出方面,函數會傳回空值控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSCorrelationID – 取得 JMSCorrelationID

介面:
xmsRC xmsMsgGetJMSCorrelationID(xmsHMsg message,
                                xmsCHAR *correlID,
                                xmsINT length,
                                xmsINT *actualLength,
                                xmsHErrorBlock errorBlock);

取得訊息的相互關係 ID。

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

參數:
message(輸入)
訊息的控點。
correlID(輸出)
內含相互關係 ID 的緩衝區。
length(輸入)
緩衝區的長度(以位元組計)。如果您指定的長度為 0, 則不會傳回相互關係 ID,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
相互關係 ID 的長度(以位元組計)。如果您在輸入中指定一個空值指標, 則不會傳回長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSDeliveryMode – 取得 JMSDeliveryMode

介面:
xmsRC xmsMsgGetJMSDeliveryMode(xmsHMsg message,
                               xmsINT *deliveryMode,
                               xmsHErrorBlock errorBlock);

取得訊息的遞送模式。遞送模式是在傳送訊息時由 xmsMsgProducerSend() 呼叫所設。

參數:
message(輸入)
訊息的控點。
deliveryMode(輸出)
訊息的遞送模式,其值為下列之一:
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT

如果是尚未傳送的新建訊息,遞送模式為 XMSC_DELIVERY_PERSISTENT,但如果是和分配管理系統間的即時連線, 則遞送模式會是 XMSC_DELIVERY_NON_PERSISTENT。如果是已接收的訊息, 函數會傳回當初在傳送訊息時由 xmsMsgProducerSend() 呼叫所設的遞送模式, 除非接收端應用程式因呼叫 xmsMsgSetJMSDeliveryMode() 而變更了遞送模式。

errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSDestination – 取得 JMSDestination

介面:
xmsRC xmsMsgGetJMSDestination(xmsHMsg message,
                              xmsHDest *destination,
                              xmsHErrorBlock errorBlock);

取得訊息的目的地。目的地是在傳送訊息時由 xmsMsgProducerSend() 呼叫所設。

參數:
message(輸入)
訊息的控點。
destination(輸出)
訊息目的地的控點。

如果是尚未傳送的新建訊息,函數會傳回一個空值控點和 XMS_E_NOT_SET 錯誤碼, 除非傳送端應用程式因呼叫 xmsMsgSetJMSDestination() 而設定了一個目的地。如果是已接收的訊息, 函數會傳回當初在傳送訊息時由 xmsMsgProducerSend() 呼叫所設之目的地的控點, 除非接收端應用程式因呼叫 xmsMsgSetJMSDestination() 而變更了目的地。

errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSExpiration – 取得 JMSExpiration

介面:
xmsRC xmsMsgGetJMSExpiration(xmsHMsg message,
                             xmsLONG *expiration,
                             xmsHErrorBlock errorBlock);

取得訊息的有效期限。

有效期限是在傳送訊息時由 xmsMsgProducerSend() 呼叫所設。其值的計算方式是, 傳送端應用程式指定的存活時間加上送出訊息的時間。有效期限是以毫秒表示, 並從 1970 年 1 月 1 日 00:00:00 GMT 開始。

如果存活時間為 0, 則 xmsMsgProducerSend() 呼叫會將有效期限設為 0,表示該訊息沒有期限。

XMS 會捨棄過期的訊息,而不會遞送給應用程式。

參數:
message(輸入)
訊息的控點。
expiration(輸出)
訊息的有效期限。

如果是尚未傳送的新建訊息,則有效期限為 0, 除非傳送端應用程式因呼叫 xmsMsgSetJMSExpiration() 而設定了一個不同的有效期限。如果是已接收的訊息, 函數會傳回當初在傳送訊息時由 xmsMsgProducerSend() 呼叫所設的有效期限, 除非接收端應用程式因呼叫 xmsMsgSetJMSExpiration() 而變更了有效期限。

errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSMessageID – 取得 JMSMessageID

介面:
xmsRC xmsMsgGetJMSMessageID(xmsHMsg message,
                            xmsCHAR *msgID,
                            xmsINT length,
                            xmsINT *actualLength,
                            xmsHErrorBlock errorBlock);

取得訊息的訊息 ID。訊息 ID 是在傳送訊息時由 xmsMsgProducerSend() 呼叫所設。

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

參數:
message(輸入)
訊息的控點。
msgID(輸出)
內含訊息 ID 的緩衝區。

如果是已接收的訊息, 函數會傳回當初在傳送訊息時由 xmsMsgProducerSend() 呼叫所設的訊息 ID, 除非接收端應用程式因呼叫 xmsMsgSetJMSMessageID() 而變更了訊息 ID。

length(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回訊息 ID,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
訊息 ID 的長度(以位元組計)。如果您在輸入中指定一個空值指標, 則不會傳回長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
XMS_X_GENERAL_EXCEPTION
附註:
  1. 如果訊息沒有訊息 ID,則函數會維持緩衝區內容不變, 將 actualLength 參數設為 0,並傳回 XMS_E_NOT_SET 錯誤碼。

xmsMsgGetJMSPriority – 取得 JMSPriority

介面:
xmsRC xmsMsgGetJMSPriority(xmsHMsg message,
                           xmsINT *priority,
                           xmsHErrorBlock errorBlock);

取得訊息的優先順序。優先順序是在傳送訊息時由 xmsMsgProducerSend() 呼叫所設。

參數:
message(輸入)
訊息的控點。
priority(輸出)
訊息的優先順序。此值為一個 0(最低優先順序)到 9(最高優先順序)範圍間的整數。

如果是尚未傳送的新建訊息, 則優先順序為 4, 除非傳送端應用程式因呼叫 xmsMsgSetJMSPriority() 而設定了一個不同的優先順序。如果是已接收的訊息, 函數會傳回當初在傳送訊息時由 xmsMsgProducerSend() 呼叫所設的優先順序, 除非接收端應用程式因呼叫 xmsMsgSetJMSPriority() 而變更了優先順序。

errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSRedelivered – 取得 JMSRedelivered

介面:
xmsRC xmsMsgGetJMSRedelivered(xmsHMsg message,
                              xmsBOOL *redelivered,
                              xmsHErrorBlock errorBlock);

取得訊息是否正在重新遞送的指示。此指示是在接收訊息時由 xmsMsgConsumerReceive() 呼叫所設。

參數:
message(輸入)
訊息的控點。
redelivered(輸出)
如果正在重新遞送訊息,則值為 xmsTRUE。如果不在重新遞送訊息,則值為 xmsFALSE

若為和分配管理系統間的即時連線, 此值固定是 xmsFALSE

errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSReplyTo – 取得 JMSReplyTo

介面:
xmsRC xmsMsgGetJMSReplyTo(xmsHMsg message,
                          xmsHDest *destination,
                          xmsHErrorBlock errorBlock);

取得訊息回覆將送往的目的地。

參數:
message(輸入)
訊息的控點。
destination(輸出)
訊息回覆將送往之目的地的控點。空值控點表示不預期會有回覆。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetJMSTimestamp – 取得 JMSTimestamp

介面:
xmsRC xmsMsgGetJMSTimestamp(xmsHMsg message,
                            xmsLONG *timeStamp,
                            xmsHErrorBlock errorBlock);

取得訊息的傳送時間。時間戳記是在傳送訊息時由 xmsMsgProducerSend() 呼叫所設, 是以毫秒表示,並從 1970 年 1 月 1 日 00:00:00 GMT 開始。

參數:
message(輸入)
訊息的控點。
timeStamp(輸出)
訊息的傳送時間。

如果是尚未傳送的新建訊息,則時間戳記為 0, 除非傳送端應用程式因呼叫 xmsMsgSetJMSTimestamp() 而設定了一個不同的時間戳記。如果是已接收的訊息, 函數會傳回當初在傳送訊息時由 xmsMsgProducerSend() 呼叫所設的時間戳記, 除非接收端應用程式因呼叫 xmsMsgSetJMSTimestamp() 而變更了時間戳記。

errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION
註:
  1. 如果未定義時間戳記,則函數會將 timeStamp 參數設為 0,但不會傳回任何錯誤。

xmsMsgGetJMSType – 取得 JMSType

介面:
xmsRC xmsMsgGetJMSType(xmsHMsg message,
                       xmsCHAR *type,
                       xmsINT length,
                       xmsINT *actualLength,
                       xmsHErrorBlock errorBlock);

取得訊息的類型。

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

參數:
message(輸入)
訊息的控點。
type(輸出)
內含訊息類型的緩衝區。如果需要轉換資料, 則此為轉換後的類型。
length(輸入)
緩衝區的長度(以位元組計)。如果您指定的是 XMSC_QUERY_SIZE, 則不會傳回訊息的類型,而會將其長度放在 actualLength 參數中傳回。
actualLength(輸出)
訊息類型的長度(以位元組計)。如果需要轉換資料, 則此為轉換後的長度。如果您在輸入中指定一個空值指標, 則不會傳回長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgGetProperties – 取得內容

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

取得訊息的內容清單。

此函數會傳回一個疊代子, 其中封裝了一份 Properties 物件清單。如此一來, 應用程式可使用疊代子依序存取每一個內容。

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

xmsMsgGetTypeId – 取得類型

介面:
xmsRC xmsMsgGetTypeId(xmsHMsg message,
                      xmsMESSAGE_TYPE *type,
                      xmsHErrorBlock errorBlock);

取得訊息的主體類型。

如需訊息主體類型的相關資訊,請參閱XMS 訊息的主體

參數:
message(輸入)
訊息的控點。
type(輸出)
訊息的主體類型,其值為下列之一:
  • XMS_MESSAGE_TYPE_BASE(訊息沒有主體)
  • XMS_MESSAGE_TYPE_BYTES
  • XMS_MESSAGE_TYPE_MAP
  • XMS_MESSAGE_TYPE_OBJECT
  • XMS_MESSAGE_TYPE_STREAM
  • XMS_MESSAGE_TYPE_TEXT
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgPropertyExists – 檢查內容是否存在

介面:
xmsRC xmsMsgPropertyExists(xmsHMsg message,
                           xmsCHAR *propertyName,
                           xmsBOOL *propertyExists,
                           xmsHErrorBlock errorBlock);

檢查訊息是否含有一個指定名稱的內容。

參數:
message(輸入)
訊息的控點。
propertyName(輸入)
採空值終止字串格式的內容名稱。
propertyExists(輸出)
如果訊息含有一個指定名稱的內容,則值為 xmsTRUE。如果訊息沒有一個指定名稱的內容,則值為 xmsFALSE
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSCorrelationID – 設定 JMSCorrelationID

介面:
xmsRC xmsMsgSetJMSCorrelationID(xmsHMsg message,
                                xmsCHAR *correlID,
                                xmsINT length,
                                xmsHErrorBlock errorBlock);

設定訊息的相互關係 ID。

參數:
message(輸入)
訊息的控點。
correlID(輸入)
字元陣列形式的相互關係 ID。
length(輸入)
相互關係 ID 的長度(以位元組計)。如果相互關係 ID 在沒有內嵌空值字元下空值終止, 您可以指定 XMSC_CALCULATE_STRING_SIZE,以容許 XMS 計算其長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSDeliveryMode – 設定 JMSDeliveryMode

介面:
xmsRC xmsMsgSetJMSDeliveryMode(xmsHMsg message,
                               xmsINT deliveryMode,
                               xmsHErrorBlock errorBlock);

設定訊息的遞送模式。

在傳送訊息前由此函數所設的遞送模式會被忽略, 並在傳送訊息時由 xmsMsgProducerSend() 呼叫所取代。不過,您可以使用此函數來變更已接收之訊息的遞送模式。

參數:
message(輸入)
訊息的控點。
deliveryMode(輸入)
訊息的遞送模式,其值必須是下列之一:
  • XMSC_DELIVERY_PERSISTENT
  • XMSC_DELIVERY_NON_PERSISTENT
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSDestination – 設定 JMSDestination

介面:
xmsRC xmsMsgSetJMSDestination(xmsHMsg message,
                              xmsHDest destination,
                              xmsHErrorBlock errorBlock);

設定訊息的目的地。

在傳送訊息前由此函數所設的目的地會被忽略, 並在傳送訊息時由 xmsMsgProducerSend() 呼叫所取代。不過,您可以使用此函數來變更已接收之訊息的目的地。

參數:
message(輸入)
訊息的控點。
destination(輸入)
訊息目的地的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSExpiration – 設定 JMSExpiration

介面:
xmsRC xmsMsgSetJMSExpiration(xmsHMsg message,
                             xmsLONG expiration,
                             xmsHErrorBlock errorBlock);

設定訊息的有效期限。

在傳送訊息前由此函數所設的有效期限會被忽略, 並在傳送訊息時由 xmsMsgProducerSend() 呼叫所取代。不過,您可以使用此函數來變更已接收之訊息的有效期限。

參數:
message(輸入)
訊息的控點。
expiration(輸入)
訊息的有效期限是以毫秒表示, 並從 1970 年 1 月 1 日 00:00:00 GMT 開始。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSMessageID – 設定 JMSMessageID

介面:
xmsRC xmsMsgSetJMSMessageID(xmsHMsg message,
                            xmsCHAR *msgID,
                            xmsINT length,
                            xmsHErrorBlock errorBlock);

設定訊息的訊息 ID。

在傳送訊息前由此函數所設的訊息 ID 會被忽略, 並在傳送訊息時由 xmsMsgProducerSend() 呼叫所取代。不過,您可以使用此函數來變更已接收之訊息的訊息 ID。

參數:
message(輸入)
訊息的控點。
msgID(輸入)
字元陣列形式的訊息 ID。
length(輸入)
訊息 ID 的長度(以位元組計)。如果訊息 ID 在沒有內嵌空值字元下空值終止, 您可以指定 XMSC_CALCULATE_STRING_SIZE,以容許 XMS 計算其長度。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSPriority – 設定 JMSPriority

介面:
xmsRC xmsMsgSetJMSPriority(xmsHMsg message,
                           xmsINT priority,
                           xmsHErrorBlock errorBlock);

設定訊息的優先順序。

在傳送訊息前由此函數所設的優先順序會被忽略, 並在傳送訊息時由 xmsMsgProducerSend() 呼叫所取代。不過,您可以使用此函數來變更已接收之訊息的優先順序。

參數:
message(輸入)
訊息的控點。
priority(輸入)
訊息的優先順序。此值可以是一個 0(最低優先順序)到 9(最高優先順序)範圍間的整數。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSRedelivered – 設定 JMSRedelivered

介面:
xmsRC xmsMsgSetJMSRedelivered(xmsHMsg message,
                              xmsBOOL redelivered,
                              xmsHErrorBlock errorBlock);

指出訊息是否正在重新遞送。

在傳送訊息前由此函數所設的重新遞送指示會被 xmsMsgProducerSend() 呼叫忽略, 並在接收訊息時由 xmsMsgConsumerReceive() 呼叫所取代。不過,您可以使用此函數來變更已接收之訊息的指示。

參數:
message(輸入)
訊息的控點。
redelivered(輸入)
xmsTRUE 表示正在重新遞送訊息。值 xmsFALSE 表示並未重新遞送訊息。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSReplyTo – 設定 JMSReplyTo

介面:
xmsRC xmsMsgSetJMSReplyTo(xmsHMsg message,
                          xmsHDest destination,
                          xmsHErrorBlock errorBlock);

設定訊息回覆將送往的目的地。

參數:
message(輸入)
訊息的控點。
destination(輸入)
訊息回覆將送往之目的地的控點。空值控點表示不預期會有回覆。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSTimestamp – 設定 JMSTimestamp

介面:
xmsRC xmsMsgSetJMSTimestamp(xmsHMsg message,
                            xmsLONG timeStamp,
                            xmsHErrorBlock errorBlock);

設定訊息的傳送時間。

在傳送訊息前由此函數所設的時間戳記會被忽略, 並在傳送訊息時由 xmsMsgProducerSend() 呼叫所取代。不過,您可以使用此函數來變更已接收之訊息的時間戳記。

參數:
message(輸入)
訊息的控點。
timeStamp(輸入)
訊息的傳送時間是以毫秒表示, 並從 1970 年 1 月 1 日 00:00:00 GMT 開始。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsMsgSetJMSType – 設定 JMSType

介面:
xmsRC xmsMsgSetJMSType(xmsHMsg message,
                       xmsCHAR *type,
                       xmsINT length,
                       xmsHErrorBlock errorBlock);

設定訊息的類型。

參數:
message(輸入)
訊息的控點。
type(輸入)
字元陣列形式的訊息類型。
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)