rename_property

Function Syntax

boolean rename_property( string old_name, string new_name )

Renames a property. Returns true on success, false on failure.

• old_name: Old property name
• new_name: New property name

To rename a property, the following conditions must be met:

• Both old_name and new_name must not be a built-in property.
• old_name must exist.
• new_name must not exist.

This function was added in r17892.

Code Samples

Rename a property named myOldPref to myNewPref.

if ( !rename_property( "myOldPref", "myNewPref" ) )
{
   abort( "Failed to rename property" );
}

See Also

get_all_properties() | property_exists() | property_has_default() | property_default_value() | get_property() | set_property() | remove_property() | rename_property()