revMoveFolder

Typecommand
DictionaryLCS
LibraryLiveCode Script
Syntax
revMoveFolder <folderToMove>, <destinationFolder>
Summary

Moves a folder with all its contents to another location.

Introduced1.1.1
OSmac, windows, linux
Platformsdesktop, server
Parameters
NameTypeDescription
folderToMove

The folderToMove specifies the name and location of the folder. If you specify a name but not a location, LiveCode assumes the folder is in the defaultFolder.

destinationFolder

The destinationFolder specifies the name and location of the folder where the folder should be placed. If you specify a name but not a location, LiveCode assumes the destination folder is in the defaultFolder.

Example
revMoveFolder "Backup Folder","/Disk/Backups/"
revMoveFolder "My App Prefs",specialFolderPath("Preferences")
Values
NameTypeDescription
The result

The revMoveFolder command uses system services on each platform to perform the move. On Mac OS and OS X systems, it uses AppleScript; on Windows and Unix systems, it uses the shell function. Any errors encountered are returned in the result function.

RelatedGlossary: application, standalone application, file, shell, subfolder, platform, command, Windows, main stack, OS X, AppleScript, group, Unix, message, folder, Mac OS, handler
Message: startup, openBackground, preOpenStack, openStack, preOpenCard
Command: create alias, delete folder, revDeleteFolder
Function: result
Library: Common library, library
Control Structure: function
Description

Use the revMoveFolder function to move a folder into another folder.

The revMoveFolder command moves the entire folder, including all files, subfolders, and their contents. The folder is removed from its original location and apppears only in the new location.

Note: When included in a standalone application, the Common library is implemented as a hidden group and made available when the group receives its first openBackground message. During the first part of the application's startup process, before this message is sent, the revMoveFolder command is not yet available. This may affect attempts to use this command in startup, preOpenStack, openStack, or preOpenCard handlers in the main stack. Once the application has finished starting up, the library is available and the revMoveFolder command can be used in any handler.