TIBCO ActiveSpaces®

Functions
iterator.h File Reference

A DataGrid iterator object traverses the rows of a table. More...

## Functions
TIBDG_API void | tibdgIterator_Close (tibEx e, tibdgIterator iterator)
| Close an iterator. More...
TIBDG_API tibbool_t | tibdgIterator_HasNext (tibEx e, tibdgIterator iterator)
| Inform the caller if the iterator has more rows or not. More...
TIBDG_API tibdgRow | tibdgIterator_Next (tibEx e, tibdgIterator iterator)
| Advance the iterator to the next row and returns it. More...

## Detailed Description

A DataGrid iterator object traverses the rows of a table.

## Function Documentation

## ◆ tibdgIterator_Close()

TIBDG_API void tibdgIterator_Close | ( | tibEx | e,
|  | tibdgIterator | iterator
| ) |  |

Close an iterator.

Releases all resources associated with this iterator object.

Parameters

  e | The exception object captures information about failures.
  iterator | The iterator to be closed.

Returns
  void

## ◆ tibdgIterator_HasNext()

TIBDG_API tibbool_t tibdgIterator_HasNext | ( | tibEx | e,
|  | tibdgIterator | iterator
| ) |  |

Inform the caller if the iterator has more rows or not.

Parameters

  e | The exception object captures information about failures.
  iterator | The iterator to be queried.

Returns
  tibbool_t

## ◆ tibdgIterator_Next()

TIBDG_API tibdgRow tibdgIterator_Next | ( | tibEx | e,
|  | tibdgIterator | iterator
| ) |  |

Advance the iterator to the next row and returns it.

This call advances the iterator beyond the current row. If the next row exists, this call returns it. If the current row is the last or if an exception has been thrown, this call returns NULL.

This call may block in order to fetch the next batch of rows.

Parameters

  e | The exception object captures information about failures.
  iterator | The iterator to be advanced.

Returns
  On success, this call returns the row.
  On failure, this call returns NULL.