browseNextElement()
browseNextElement() 関数は、指定された iSeries データ・キューからデータを読み取ります。 ただし、キューからデータは削除しません。 この関数を getNextElement() と比較してみると、後者の関数ではデータの読み取りは 同様に行われますが、キューからデータが削除されます。
データの宛先が HEX(2) 要素の配列から構成される場合、 これは未加工バイトとして読み取られます。 その他の場合、データは STRING として読み取られます。
この関数は、キーの指定がなければ、キューの最初の要素を読み取ります。キーを指定した場合は、 キーと検索タイプ (キー値よりも大きい、キー値に等しくない、など) に一致する要素を読み取ります。
構文
iplatformLib.browseNextElement(
dataQueueDef DataQueueDefinition inOut,
elementData ANY inOut,
wait INT in,
[, keyData ANY in,
searchType CHAR[2] inOut] )
returns (result BOOLEAN)
- platform
- プログラムを生成しているプラットフォームにより、ストリング「Cobol」または「Java™」。
- dataQueueDef
- DataQueueDefinition レコードに基づく変数 (iSeries レコード定義を参照)。
- elementData
- データの宛先。データ型が HEX(2)[] の場合、 データはバイトとして読み取られます。 その他の場合、データは STRING 型として読み取られます。
- wait
- 関数が読み取り操作を完了できない場合の待ち時間 (秒数)。2 つの特殊なケースがあります。
- 0
- 即時、戻します。
- -1
- 永久に待ちます。
- keyData
- キー付きデータ・キューのオプションのキー指定。
- searchType
- 突き合わせるデータが満たす必要のある keyData への関係。検索タイプには、次のいずれかの関係が含まれます。
- GT
- 関数は、キー値が keyData 内のものより大きな要素のみを読み取ります。
- GE
- 関数は、キー値が keyData 内のものより大きいか等しい要素のみを読み取ります。
- EQ
- 関数は、キー値が keyData 内のものと等しい要素のみを読み取ります。
- NE
- 関数は、キー値が keyData 内のものに等しくない要素のみを読み取ります。
- LE
- 関数は、キー値が keyData 内のものより小さいか等しい要素のみを読み取ります。
- LT
- 関数は、キー値が keyData 内のものより小さい要素のみを読み取ります。
- result
- 関数は、読み取りが正しく行われると、TRUE を戻します。