Property :: rename - Rename instance
The rename function allows changing the key value for the access key in the selected instance to the new key value passed in vNewKey. The key value must correspond to the access key definition. Missing components at end of key are assumed to contain empty values. After changing the key value the instance is stored.
The effect is the same as changing the key attributes in the instance, unless that no knowledge about key attributes is required.
When no instance is selected or when a duplicate key has been defined for a unique index, the function throws an exception and the key value remains unchanged.
Implementation details
- vNewKey
- New key value for instance
The key passed for renaming the instance must be structured according to the currently selected sort order. Key components within a key must be separated by '|' or ';'. An empty string can be passed in order to indicate no key value.
In order to pass no key value, an empty string ( String() ) has to be passed.