Livecode Wiki
Advertisement

Gives a file or folder a new name or moves it to a new location or both.

Built-in Message handler[]

Syntax:

rename [file | folder |directory] <filePath> to <newPath>

Examples:

rename file "Foo.txt" to "Bar.txt"
rename folder "/bin/utilities/help" to "/public/utilities/new-help"

Use the rename command to change the name or location of a file or folder.

The rename command can be used to change a file's or folder's location only if the old and new locations are both on the same volume.

Warning: This command can be used also to rename or move files and folders your stack did not create. Of course, a stack should not rename or move files and folders it didn't create without obtaining explicit confirmation from the user. (So please ask to user confirmation before creating big problems)

Changes: The ability to move a file or folder on Mac OS and Windows systems with the rename command was introduced in version 1.1.1. In previous versions, the rename command could be used only to change the name, not the location.

Parameters:

  • filePath: The filePath specifies the current name and location of the file or folder you want to rename or move. If you specify a name but not a location, LiveCode assumes the file or folder is in the defaultFolder.
  • newPath: The newPath specifies the new name and location of the file or folder.

See also: tempName (function), files (function), folders (function), stack (object), fileType (property),

Advertisement