company logo

PropertyHandle :: Rename - Rename instance

The rename function allows changing the sort key value of the selected instance. 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 the key attributes is required.

The function returns an error (YES) when no instance is selected or when

Return value:  Success ( logical  )

Implementation details

logical PropertyHandle  :: Rename ( ::Key new_key )
  • new_key - New key for the instance

    The key passed for renaming the instance must be structured according to the currently selected sort order.