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

QueueBrowser

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

繼承階層:
xms::PropertyContext
   |
   +----xms::QueueBrowser

方法

方法摘要:
方法 說明
close 關閉佇列瀏覽器。
getEnumeration 取得佇列上的訊息清單。
getHandle 取得 C 應用程式在存取佇列瀏覽器時所要使用的控點。
getMessageSelector 取得佇列瀏覽器的訊息選取器。
getQueue 取得佇列瀏覽器的相關聯佇列。
isNull 判斷 QueueBrowser 物件是否為一個空值物件。

close – 關閉佇列瀏覽器

介面:
xmsVOID close();

關閉佇列瀏覽器。

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

參數:
傳回:
Void
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getEnumeration – 取得訊息

介面:
Iterator getEnumeration() const;

取得佇列上的訊息清單。

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

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

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

參數:
傳回:
Iterator 物件。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getHandle – 取得控點

介面:
xmsHQueueBrowser getHandle() const;

取得 C 應用程式在存取佇列瀏覽器時所要使用的控點。

參數:
傳回:
佇列瀏覽器的控點。
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getMessageSelector – 取得訊息選取器

介面:
String getMessageSelector() const;

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

參數:
傳回:
封裝訊息選取器表示式的 String 物件。如果需要轉換資料, 則此為轉換後的訊息選取器表示式。如果佇列瀏覽器沒有訊息選取器,則方法會傳回空值 String 物件。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

getQueue – 取得佇列

介面:
Destination getQueue() const;

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

參數:
傳回:
代表佇列的 Destination 物件。
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

isNull – 檢查是否為空值

介面:
xmsBOOL isNull() const;

判斷 QueueBrowser 物件是否為一個空值物件。

參數:
傳回:
  • 如果 QueueBrowser 物件為空值物件,則為 xmsTRUE
  • 如果 QueueBrowser 物件不是空值物件,則為 xmsFALSE
執行緒環境定義:
任何
異常狀況:
  • XMS_X_GENERAL_EXCEPTION

繼承的方法


Reference topic

使用條款 | 評比此網頁

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