filerename statement

filerename

PATH

NEWPATH

The filerename statement renames and/or moves a file or folder.

Parameters

This statement has two parameters:

path – is a path to the file or folder to be renamed and/or moved, including the file name (see Files and Folders for more information about file paths).

newpath – is the new name for the file or folder, or an entirely new path if the file or folder is to be moved to a new location.

Description

This statement renames and/or moves an item on disk. The item may be a single file or an entire folder.

To rename an item in place, the first parameter specifies the file or folder, while the second specifies the new name. This example causes the file index.html to be renamed home.html:

filerename "~/Documents/Web Site/index.html","home.html"

The filerename statement can also rename an entire folder (this does not affect the contents of the folder). This example changes the name of the Web Site folder, the new name is Acme Web Site:

filerename "~/Documents/Web Site","Acme Web Site"

If the second parameter contains a full path, the item will be moved to a new location (and will also be renamed, if the file name is different). This example moves a file from the Documents folder into the Dropbox folder:

filerename "~/Documents/logo.png","~/Dropbox/logo.png"

You can rename and move an item all in one fell swoop:

filerename "~/Documents/logo.png","~/Dropbox/newlogo.png"

You can also move an entire folder all at once:

filerename "~/Documents/Web Site","~/Dropbox/Acme Web Site"

Keep in mind that moving an item is different than copying it. When you copy an item (see copyfile and copyfolder) Panorama creates a second copy of the item in the new location, but the original remains in place. When you move an item, the item is removed from the original location. There is no additional copy made.

If the old and new locations of the item are on the same disk, the item can be moved almost instantaneously. However, if the new location is on a different disk, the operation can take a significant amount of time. To move an item across disks, Panorama actually copies the item and then erases the original item. Especially for folders, this can take quite a bit of time.

Legacy Three Parameter Syntax

Previous versions of Panorama (version 6 and before) used a three parameter format for the filerename statement:

filerename folder,filename,newfilename

For compatibility with existing databases, this format still works.

See Also

aliaspath( -- returns the path an alias points to (or an error if the specified file isn't an alias).
archivecontents( -- lists the contents of a compressed archive in *.zip*, *.tar.gz* or *.tar.bz2* format.
bookmarkpath( -- converts saved bookmark data (from the filebookmark( function) into a standard file path.
bundleresourcepath( -- returns the file path and name of a specified item in the Panorama application bundle.
choosefiledialog -- displays a modal dialog allowing selection of files or folders.
choosefolderdialog -- pauses and displays the standard “choose folder” dialog.
commonpath( -- returns the path for common folders (desktop, library, documents, pictures, etc.).
compress -- compresses a file or an entire folder.
copyfile -- copies a file (or folder).
copyfolder -- copies an entire folder full of files (and subfolders, if any).
copynewerfile -- copies a file to another name or location. However, the file is only copied if it is newer than the old file, otherwise the destination is not touched.
copynewerfile( -- copies a file to another name or location. However, the file is only copied if it is newer than the old file, otherwise the destination is not touched.
copynewerfolder -- copies an entire folder full of files, but only copies newer files.
dbfolder( -- returns the folder path of the folder the current database is located in.
dbname( -- returns the name of the current database.
dbpath( -- returns the HFS path of the folder the current database is located in.
dbsubfolder( -- returns the path of a subfolder within the same folder as the current database.
dropfromfinder -- processes any files or folders that have been dropped on a form from the finder.
dropimagesfromfinder -- processes images that have been dropped on a form from the Finder. The images may be added to new records in the database or put in the current record.
enclosingfolder( -- takes a full path and filename and returns the name of the folder that contains the file.
enclosingpath( -- takes a full path and filename and returns the path of the folder that contains the file.
fileappend -- appends new data to an existing disk file.
fileattributes( -- returns attributes of the specified file or folder (date, owner, permissions, etc.).
filebookmark( -- converts a file or folder path into a binary data value that persistently links to the file, even if it is later moved or renamed.
filecatalog( -- builds a text array listing the files in a folder, including any subfolders of that folder.
filedate( -- returns the modification date of a file.
filedisplayname( -- returns the display name for the specified file or folder.
fileerase -- erases a disk file or a folder, removing it from the hard disk.
fileexists( -- returns true if a file exists, false if it does not.
fileexistspath( -- tests to see if a file exists.
fileextension( -- extracts the extension (if any) from a partial or complete path and filename.
filefolder( -- returns the folder ID of the folder that contains the specified file.
fileidnumber( -- returns the id number for the specified file or folder.
fileinfo( -- returns information about a file (or folder) on the disk, including the size, creation and modification date and time, type, creator and lock status.
fileload( -- reads the entire contents of any file on disk.
fileloadpartial( -- reads a portion of the contents of any file on disk.
filename( -- extracts the filename from a complete path and filename.
filepath( -- extracts the path from a combined path and filename.
Files and Folders -- organization of files and folders
filesave -- saves data directly into a disk file.
filesize( -- determines the size of any file on disk.
filesuperdate( -- returns the modification date and time of a file.
filetime( -- returns the modification time of a file.
filetypecreator( -- returns the type and creator code of the specified file (if any).
folder( -- creates a *Folder ID* that unambiguously describes the location of a folder on the hard disk.
foldercontains( -- checks to see if a folder contains a specified file. See also the pathcontains( function.
foldercontents( -- returns a list of all of the contents of a folder.
foldercount( -- returns the total number of files within a folder (including any subfolders).
folderexists( -- returns true if a folder exists, false if it does not.
folderpath( -- converts a Folder ID into the HFS path of that folder.
foldersepchar( -- returns the separator character used between folders.
foldersize( -- calculates the size of a folder (in bytes).
fullpath( -- converts a filename or relative path (starting with the : or / symbol) into a full HFS path, including the disk name.
hfspath( -- converts a UNIX path into an HFS path.
homepath( -- returns the HFS path of a subfolder of the current users home folder.
homesubfolder( -- returns the folder id of a subfolder of the current user's home folder.
hostedfiles( -- returns a list of open databases associated with a specified host (server).
info("applicationsfolder") -- returns the path to the current user's Applications folder.
info("applicationsupportfolder") -- returns the path to the current user's Application Support folder (inside the Library folder).
info("cachefolder") -- returns the path to the current user's Cache folder (in the Library folder).
info("desktopfolder") -- returns the path to the user's desktop folder.
info("documentsfolder") -- returns the path to the current user's Documents folder.
info("downloadsfolder") -- returns the path to the current user's Downloads folder.
info("dropfiles") -- returns a list of files dragged onto a *Drag Receiver* form object (see Drag and Drop).
info("foldersepchar") -- returns the separator character used between folders.
info("libraryfolder") -- returns the path to the current user's Library folder.
info("moviesfolder") -- returns the path to the current user's Movies folder.
info("musicfolder") -- returns the path to the current user's Music folder.
info("panoramafolder") -- returns the location of the folder containing the currently running copy of Panorama.
info("picturesfolder") -- returns the path to the current user's Pictures folder.
info("publicfolder") -- returns the path to the current user's Public folder.
info("tempfolder") -- returns the path to the current user's temporary folder (for files you plan to use only for a short time).
info("userfolder") -- returns the path to the current user's home folder.
info("volumes") -- returns a list of all of the currently mounted volumes (disks) on the computer.
listfiles( -- builds a text array listing the files in a folder.
listpanoramafiles( -- returns a list of panorama database files in the specified folder.
listtextfiles( -- returns a list of text files in the specified folder.
makefolder -- creates a new folder, and if necessary, also creates any enclosing folders needed to create the specified new folder.
makepackage -- creates a new package, and if necessary, also creates any enclosing folders needed to create the specified new package.
modifyfileattributes -- modifies one or more attributes of a file (or folder).
openanything -- opens a document or application.
openfiledialog -- pauses and displays the standard “open file” dialog.
openwith -- opens a document with a specific application.
openwithterminal -- opens an application in a new Terminal.app window (useful for debugging).
pathcontains( -- checks to see if a folder contains a specified file (or folder).
pathcontents( -- lists the contents of a folder (specified by a path)
pathexists( -- checks to see if a path exists.
pathseparator( -- returns the type of separator character used in a file path (either / or :).
posixpath( -- converts a path and filename into a POSIX path that can be used as a parameter to a shell command.
revealinfinder -- reveals a file or folder in the Finder.
revealmultipleinfinder -- reveals one or more files or folders in the Finder.
savedialog -- displays a modal dialog that allows a user to specify the name and location of a new file.
savefiledialog -- pauses a procedure and displays the standard “save file” dialog.
subfolder( -- returns the folder id of a subfolder of a specified folder
subpath( -- returns the HFS path of a subfolder of a specified folder.
tempfolder( -- returns the path to the current user's temporary folder (for files you plan to use only for a short time).
tildepath( -- converts a path in the current user's folder to tilde (~) notation.
typecreatorcode( -- returns the 8 character TYPE and CREATOR codes for a filename (if any).
uncompress -- uncompresses a `.zip`, `.tar.gz` or `.tar.bz2` file into a file or an entire folder.
unixpath( -- converts an HFS path into a UNIX path.
unixshellpath( -- converts a path and filename into a POSIX path that can be embedded within the shellscript statement.
zipcompress -- compresses a file or an entire folder into a zip file (using ditto shell tool).
zipuncompress -- uncompresses a file or an entire folder from a zip file (using ditto shell tool).

History

Version	Status	Notes
10.0	Updated	Carried over from Panorama 6.0 but now uses a 2 parameter syntax (path,newpath). The filerename statement also now allows items to be moved to a new location as well as being renamed. (The old 3 parameter syntax is still available.)