company logo

PropertyHandle :: GetCurrentIndex - Get cursor position

The function returns the position of the currently selected instance in the collection according to the selected sort order. The function returns a value when an instance has been located in the property handle (e.g. LocateKey()) regardless whether the instance has been read or not.

Since the position might change when instances are inserted or removed from the collection the current index can be used for accessing instances (Get(indx0)) in a limited way (e.g. within a transaction).

Return value:  Position in the collection according to current sort order ( int32  )

The position refers to the position of an instance reference in a local or global collection. The instance position refers to the position according to the selected index (sort order, -> {.r pib.SetOrder}()).

If the selected index is not unique the system decides the order among instances with the same key value.

The position may change when inserting or deleting instances (e.g. in other applications)..

Implementation details

int32 PropertyHandle  :: GetCurrentIndex (  )