Iterator Template

currentRow()

Return the current row number.

Syntax

number = rb.iterator.currentRow()

Parameters

The 'currentRow' method takes no parameters

Results

The 'currentRow' method returns number:

Remarks

This method returns the index into the table of the row currently held in the iterator data properties. If the iterator currently contains no data then the value returned by the method is -1. There are two situations under which the iterator will contain no data:

1. iterator.getNextRow had not yet been called for the first time.
2. iterator.getNextRow has been called but the virtual table is empty and no data was retrieved. In this case iterator.getNextRow will have returned false.

The first row index in the table is 'zero' (0).