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

QueueBrowser

應用程式會使用佇列瀏覽器來瀏覽佇列上的訊息,而不移除它們。

函數

函數摘要:
函數 說明
xmsQueueBrowserClose 關閉佇列瀏覽器。
xmsQueueBrowserGetEnumeration 取得佇列上的訊息清單。
xmsQueueBrowserGetMessageSelector 取得佇列瀏覽器的訊息選取器。
xmsQueueBrowserGetQueue 取得佇列瀏覽器的相關聯佇列。

xmsQueueBrowserClose – 關閉佇列瀏覽器

介面:
xmsRC xmsQueueBrowserClose(xmsHQueueBrowser *browser,
                           xmsHErrorBlock errorBlock);

關閉佇列瀏覽器。

如果應用程式試著關閉已關閉的佇列瀏覽器, 則會忽略該呼叫。

參數:
browser(輸入/輸出)
在輸入方面,為佇列瀏覽器的控點。在輸出方面,函數會傳回空值控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsQueueBrowserGetEnumeration – 取得訊息

介面:
xmsRC xmsQueueBrowserGetEnumeration(xmsHQueueBrowser browser,
                                    xmsHIterator *iterator,
                                    xmsHErrorBlock errorBlock);

取得佇列上的訊息清單。

此函數會傳回一個疊代子, 其中封裝了一份 Message 物件清單。清單中的 Message 物件次序和從佇列擷取訊息的次序相同。如此一來, 應用程式可使用疊代子依序瀏覽每一則訊息。

只要訊息被放到佇列上以及從佇列中移除時, 即會動態更新疊代子。每當應用程式呼叫 xmsIteratorGetNext() 以瀏覽佇列中的下一則訊息時, 所傳回的訊息會反映佇列的現行內容。

如果應用程式針對給定的佇列瀏覽器呼叫此函數多次, 則每次的呼叫都會傳回一個新疊代子。如此一來,應用程式可使用一個以上的疊代子來瀏覽佇列上的訊息, 並維護佇列中的多個位置。

參數:
browser(輸入)
佇列瀏覽器的控點。
iterator(輸出)
疊代子的控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

xmsQueueBrowserGetMessageSelector – 取得訊息選取器

介面:
xmsRC xmsQueueBrowserGetMessageSelector(xmsHQueueBrowser browser,
                                        xmsCHAR *messageSelector,
                                        xmsINT length,
                                        xmsINT *actualLength,
                                        xmsHErrorBlock errorBlock);

取得佇列瀏覽器的訊息選取器。

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

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

xmsQueueBrowserGetQueue – 取得佇列

介面:
xmsRC xmsQueueBrowserGetQueue(xmsHQueueBrowser browser,
                              xmsHDest *queue,
                              xmsHErrorBlock errorBlock);

取得佇列瀏覽器的相關聯佇列。

參數:
browser(輸入)
佇列瀏覽器的控點。
queue(輸出)
代表佇列的 Destination 物件控點。
errorBlock(輸入)
錯誤區塊的控點或空值控點。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

Reference topic

使用條款 | 評比此網頁

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