Property :: getKey - Get key at position
When the requested instance exists, the function returns true and the key value in rKey contains the key value at given position. When no instance exists atrequested position, the function returns false. When the property handle is invalid, the function throes an exception.
The value is true when the function was executed successfully. Otherwise the value is set to false.
Implementation details
The function fills the key at index position iPosition in the selected index for a collection. The key value is copied to the key passed in rKey. The function may be called instead of Property::key(iPosition) in order to optimize key access.
When passing -1 in iPosition, the function returns the key for the currently located instance. When no instance is located, the function throws an exception.
- rKey
- Key value
A key value is the key definition and a value for the key. The key value is typically provided in ESDF format. Other formats might be set (OIF, XML)
- iPosition
- Position in collection
The position of an element in a collection is beginning with 0 for the first element.