3.14. QueueBrowserインタフェース

QueueBrowserインタフェースは、C言語ランタイムライブラリにてJMSのQueueBrowserオブジェクトへのインタフェースを提供します。

QueueBrowserインタフェースには次の関数があります。

JmsQueueBrowserClose QueueBrowserオブジェクトを閉じます。
JmsQueueBrowserGetEnumeration QueueBrowserオブジェクトからキューメッセージのリストを受信順に表示します。
JmsQueueBrowserGetMessageSelector QueueBrowserオブジェクトのメッセージセレクタ式を取得します。
JmsQueueBrowserGetQueue QueueBrowserオブジェクトに関連付けられた送信先オブジェクトを取得します。

   
3.14.1. JmsQueueBrowserClose

名称 JmsQueueBrowserClose - QueueBrowserオブジェクトを閉じます。
形式 WOJMSStatus JmsQueueBrowserClose( JmsQueueBrowser *browser );
説明 browserで指定したJmsQueueBrowserに指定されているQueueBrowserオブジェクトを閉じます。 プロバイダは QueueBrowser に対応するリソースを Java 仮想マシン外部に割り当てる場合があるため、これらのリソースが不要になった場合、クライアントがリソースを閉じる必要があります。
引数 I/O パラメータ 説明
I browser closeメソッドを呼び出すQueueBrowserオブジェクトを指すJmsQueueBrowser構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 QueueBrowserオブジェクトが無効です。
関連項目 javax.jms.QueueBrowser.close()
   
3.14.2. JmsQueueBrowserGetEnumeration

名称 JmsQueueBrowserGetEnumeration - QueueBrowserオブジェクトからキューメッセージのリストを受信順に表示します。
形式 WOJMSStatus JmsQueueBrowserGetEnumeration( JmsQueueBrowser *browser, JmsEnumeration *enumeration );
説明 browserで指定したJmsQueueBrowserに指定されているQueueBrowserオブジェクトから現在のキューメッセージの表示用列挙を受信順に取得し、引数enumerationに格納します。
引数 I/O パラメータ 説明
I browser getEnumerationメソッドを呼び出すQueueBrowserオブジェクトを指すJmsQueueBrowser構造体へのポインタを指定します。
O enumeration 取得したキューメッセージ群を格納するJmsEnumeration構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 QueueBrowserオブジェクトが無効です。
関連項目 javax.jms.QueueBrowser.getEnumeration()
   
3.14.3. JmsQueueBrowserGetMessageSelector

名称 JmsQueueBrowserGetMessageSelector - QueueBrowserオブジェクトのメッセージセレクタ式を取得します。
形式 WOJMSStatus JmsQueueBrowserGetMessageSelector( JmsQueueBrowser *browser, JmsString *selector );
説明 browserで指定したJmsQueueBrowserに指定されているQueueBrowserオブジェクトからメッセージセレクタ式を取得し、引数selectorに格納します。
引数 I/O パラメータ 説明
I browser getMessageSelectorメソッドを呼び出すQueueBrowserオブジェクトを指すJmsQueueBrowser構造体へのポインタを指定します。
O selector 取得したメッセージセレクタ式を格納する、JmsStringへのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INSUFFICIENT_MEMORY_ERROR -1 メモリ不足のため、バッファの確保に失敗しました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 QueueBrowserオブジェクトが無効です。
関連項目 javax.jms.QueueBrowser.getMessageSelector()
   
3.14.4. JmsQueueBrowserGetQueue

名称 JmsQueueBrowserGetQueue - QueueBrowserオブジェクトに関連付けられた送信先オブジェクトを取得します。
形式 WOJMSStatus JmsQueueBrowserGetQueue( JmsQueueBrowser *browser, JmsQueue *queue );
説明 browserで指定したJmsQueueBrowserに指定されているQueueBrowserオブジェクトに関連付けられた送信先オブジェクトを取得し、引数queueに格納します。
引数 I/O パラメータ 説明
I browser getQueueメソッドを呼び出すQueueBrowserオブジェクトを指すJmsQueueBrowser構造体へのポインタを指定します。
O queue 取得した送信先オブジェクトを格納する、JmsQueue構造体へのポインタを指定します。
戻り値 WOJMS_NO_ERROR 0 正常に終了しました。
WOJMS_CAUGHT_EXCEPTION 1 関数実行中にスレッド内でExceptionがthrowされました。
WOJMS_INVALID_ARGUMENT_ERROR -2 指定された引数が不正です。
WOJMS_JVM_ERROR -4 JavaVMが無効です。
WOJMS_OBJECT_NOT_ACTIVE_ERROR -7 QueueBrowserオブジェクトが無効です。
関連項目 javax.jms.QueueBrowser.getQueue()