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 (入出力)
入力では、キュー・ブラウザーのハンドル。出力で、関数は NULL ハンドルを戻します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsQueueBrowserGetEnumeration – メッセージの取得

インターフェース:
xmsRC xmsQueueBrowserGetEnumeration(xmsHQueueBrowser browser,
xmsHIterator *iterator,
xmsHErrorBlock errorBlock);

キュー上のメッセージのリストを取得します。

この関数は、Message オブジェクトのリストをカプセル化するイテレーターを戻します。リスト内の Message オブジェクトの順序は、メッセージがキューから取り出される順序と同じです。アプリケーションは、そのイテレーターを使用して、各メッセージを順番に参照することができます。

イテレーターは、メッセージがキューに置かれたとき、およびキューから除去されたときに動的に更新されます。アプリケーションがキュー上の次のメッセージを参照するために xmsIteratorGetNext() を呼び出すたびに、戻されるメッセージはキューの現在の内容を反映しています。

アプリケーションが、特定のキュー・ブラウザーに対してこの関数を複数回呼び出した場合、呼び出すたびに新しいイテレーターが戻されます。そのため、アプリケーションは、複数のイテレーターを使用してキュー上のメッセージを参照し、キュー内の複数の位置を維持することができます。

パラメーター:
browser (入力)
キュー・ブラウザーのハンドル。
iterator (出力)
イテレーターのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • 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 (出力)
メッセージ・セレクター式の長さ (バイト単位)。データ変換が必要な場合、これは変換後のメッセージ・セレクター式の長さです。 入力に NULL ポインターを指定すると、長さが戻されません。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsQueueBrowserGetQueue – キューの取得

インターフェース:
xmsRC xmsQueueBrowserGetQueue(xmsHQueueBrowser browser,
xmsHDest *queue,
xmsHErrorBlock errorBlock);

キュー・ブラウザーに関連付けられたキューを取得します。

パラメーター:
browser (入力)
キュー・ブラウザーのハンドル。
queue (出力)
キューを表す Destination オブジェクトのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
例外:
  • 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)