Property :: currentPosition - Current index property
The function returns the position of the currently located instance in the collection according to the selected access key. The property returns a non negative value when an instance has been located in the property handle (e.g. locateKey() ) regardless whether the instance has been selected or not.
When no instance is located in the property handle, the property returns -1 .
Since the position might change when instances are inserted or removed from the collection, the current index can be used for accessing instances ( get( iPosition ) ) in a limited way, only (e.g. within a transaction).
Return value: Position in collection ( int32 )
The position of an element in a collection is beginning with 0 for the first element.