TIBCO FTL®

Public Member Functions | List of all members
TIBCO.FTL.ITibMapIterator Interface Reference

Map iterators iterate over the key/value pairs in a map. More...

Inheritance diagram for TIBCO.FTL.ITibMapIterator:

## Public Member Functions
String | CurrentKey ()
| Get the key from the current key/value pair. More...
IMessage | CurrentValue ()
| Get the message value from the current key/value pair. More...
bool | Next ()
| Iterate to the next key/value pair. More...

## Detailed Description

Map iterators iterate over the key/value pairs in a map.

An iterator can produce values added to a map after the iterator is created.

To create a map iterator object, see ITibMap.CreateIterator(ITibProperties).

This file defines map iterator calls.

Customers do not implement this interface.

## Member Function Documentation

## ◆ CurrentKey()

String TIBCO.FTL.ITibMapIterator.CurrentKey | ( |  | ) |

Get the key from the current key/value pair.

The library owns the key string, and may destroy it after the program calls ITibMapIterator.Next or destroys the iterator object.

Returns
  The key string.

## ◆ CurrentValue()

IMessage TIBCO.FTL.ITibMapIterator.CurrentValue | ( |  | ) |

Get the message value from the current key/value pair.

The library owns the message object, and may destroy it after the program calls ITibMapIterator.Next or destroys the iterator object.

Returns
  The value (which is a message object).

## ◆ Next()

bool TIBCO.FTL.ITibMapIterator.Next | ( |  | ) |

Iterate to the next key/value pair.

If the iterator has an associated lock and the process does not hold that lock, the call throws an exception and does not advance to the next pair. (See also ITibMap.CreateIterator(ITibLock,ITibProperties).)

To get the key and value from each pair, see ITibMapIterator.CurrentKey and ITibMapIterator.CurrentValue.

Returns
  - True indicates that the next pair is ready.
  - False indicates that the iteration is complete.