Rename Method  
 

Change the label of an existing storage object.

Syntax

object.Rename( OldLabel, NewLabel )

Parameters

OldLabel
A string which specifies the label of the object that should be moved.
NewLabel
A string which specifies the new label for the object being moved. An object with this label cannot already exist.

Return Value

A value of True is returned if the object was renamed. Otherwise, a value of False is returned and the LastError property will return the specific cause of the failure.

Remarks

The Rename method is used to change the label of an existing storage object within the current storage container. If you wish to move an object to a different container, use the Move method.

This method updates the current object. Various properties such as ObjectId and ObjectLabel will reflect the values associated with the object which has been renamed.

See Also

Copy Method, Delete Method, Move Method