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

ご利用条件 | フィードバック (英語のみ)

Timestamp icon最終更新: 8 Jun 2006
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.
このインフォメーション・センターでは Eclipse テクノロジーが採用されています。(http://www.eclipse.org)