This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions page (login required).

%Iterator.Object

class %Iterator.Object extends %Iterator.Array

Method Inventory (Including Private)

Methods

method %GetNext(Output key, Output value) as %Integer
getNext() advances the iterator and returns true if the iterator is positioned on a valid element, false if it is beyond the last element. The key for the element is returned in the first output argument and the value in the second. To call this method, pass the key and value arguments by reference to receive their return values. To iterate over an array, use the following pattern: while iterator.getNext(.key,.value) { // key and value now contain the key for the element and value contains the value. }

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback