PropertyHandle :: GetCurrentKey - Get ident-key value from selected instance
The function locates the instance according to the position passed in set_pos_w. When no position or AUTO (-1) had been passed, the function works on the currently selected instance.
The function extracts the identifying-key value according to the structure definition of the currently selected instance. For weak-typed collections this may differ from the identifying-key for the data type defined as base type for the collection.
For fixed typed properties the function works similar to GetKey().
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