PropertyHandle :: GetIndexName - Name of the current index
The function returns the index name of the index for the n-th (indx0) index (sort order for collection). The function returns NULL, if indx0 is equal or larger than the number of indexes defined for the collection.
The index or key name refers to an index defining an order for the collection. Indexes are always referenced by key names.
Implementation details
- indx0
- Position in collection
The position of an instance in a collection depends on the selected index. if the collection is unsorted the position is the only way for accessing the instance.
For sorted collections the position is determined according to the instance key. If is a contradiction between position and key value the position will be ignored.
Special positions are
CUR_INSTANCE (-1) refers to the currently selected instance. If no instance is selected it refers to the first instance.
FIRST_INSTANCE (0) refers to the first instance in a collection according to the selected index (sort order).
FIRST_INSTANCE (0x7fffffff) refers to the last instance in a collection according to the selected index (sort order).