PropertyHandle :: GetKey - Get key for index position
The function locates and returns the key value at a certain position (set_pos0) in the selected index. The first key is provided by passing 0 as position.
The key is provided in the internal key format. When necessary the key value can be converted from a string into the internal format using the StringToKey() function.
Implementation details
- set_pos0_w
- 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).
Default: AUTO