WebSphere Message Service Clients for C/C++ and .NET, Version 1.2 オペレーティング・システム: Linux, Windows

Iterator

イテレーターは、オブジェクトのリストをカプセル化します。 アプリケーションは、イテレーターを使用して、各オブジェクトに順番にアクセスします。

イテレーターは、リスト内の現在位置を保持するカーソルもカプセル化します。イテレーターの作成時には、カーソルの位置は最初のオブジェクトの前です。

アプリケーションは、イテレーターを直接作成することはできません。イテレーターは、オブジェクトのリストをアプリケーションに戻すために、特定の関数によってのみ作成されます。

これはヘルパー・クラスです。

関数

関数の要約:
関数 説明
xmsIteratorDispose イテレーターを削除します。
xmsIteratorGetNext カーソルを次のオブジェクトに移動し、カーソルの新規の位置にあるオブジェクトを取得します。
xmsIteratorHasNext カーソルの現在位置よりも後にさらにオブジェクトがあるかどうかを検査します。
xmsIteratorReset カーソルを、最初のオブジェクトの前の位置に戻します。

xmsIteratorDispose – イテレーターの削除

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

イテレーターを削除します。

アプリケーションが、既に削除されているイテレーターを削除しようとした場合、呼び出しは無視されます。

パラメーター:
iterator (入出力)
入力では、イテレーターのハンドル。出力で、関数は NULL ハンドルを戻します。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsIteratorGetNext – 次のオブジェクトの取得

インターフェース:
xmsRC xmsIteratorGetNext(xmsHIterator iterator,
xmsHObj *object,
xmsHErrorBlock errorBlock);

カーソルを次のオブジェクトに移動し、カーソルの新規の位置にあるオブジェクトを取得します。

パラメーター:
iterator (入力)
イテレーターのハンドル。
object (出力)
オブジェクトのハンドル。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsIteratorHasNext – さらにオブジェクトがあることの検査

インターフェース:
xmsRC xmsIteratorHasNext(xmsHIterator iterator,
xmsBOOL *moreProperties,
xmsHErrorBlock errorBlock);

カーソルの現在位置よりも後にさらにオブジェクトがあるかどうかを検査します。この呼び出しによって、カーソルは移動しません。

パラメーター:
iterator (入力)
イテレーターのハンドル。
moreProperties (出力)
カーソルの現在位置よりも後にさらにオブジェクトがある場合、値は xmsTRUE です。カーソルの現在位置よりも後にはオブジェクトがない場合、値は xmsFALSE です。
errorBlock (入力)
エラー・ブロックのハンドルまたは NULL ハンドル。
スレッド・コンテキスト:
任意
例外:
  • XMS_X_GENERAL_EXCEPTION

xmsIteratorReset – イテレーターのリセット

インターフェース:
xmsRC xmsIteratorReset(xmsHIterator iterator,
xmsHErrorBlock errorBlock);

カーソルを、最初のオブジェクトの前の位置に戻します。

パラメーター:
iterator (入力)
イテレーターのハンドル。
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)