mapiterator

Holds the mapiterator datatype

Associated DataTypes

mapiterator

A mapiterator implements a forward iterator over the map type. A forward iterator is an iterator that can only be incremented. Invoking Advance on the iterator will position the iterator on the next element with a value lexicographically greater than the current element. If there is no next element, the iterator will be positioned on the end of the map and IsEnd will be true.

Members

bool Reset

Positions the iterator to the start of the map. True is always returned.

bool Advance

The iterator is moved to the next item in the map, if one exists. True is returned if the iterator was advanced and False otherwise.

bool IsEnd

True if the iterator is at the end of the map.

string Value

Returns the element of the map under the iterator.

string Key

Returns the unique key for the element of the map under the iterator.

mapiterator Clone

Returns a copy of the current mapiterator. A copy has independent life and initially is over the same element as the source iterator.

This TLO is added by MQ2Collections.