Livecode Wiki
Advertisement

Removes a folder and all its contents.

Syntax:

revDeleteFolder <folderToDelete>

Examples:

revDeleteFolder "/data/Backup Folder"
revDeleteFolder myTempFolder

Use the revDeleteFolder function to remove a folder from the disk.

The revDeleteFolder command removes the entire folder, including all files, subfolders, and their contents.

On Mac OS and OS X systems, the revDeleteFolder command places the folder in the Trash.

This command can be used to rename or move files and folders your stack did not create. Of course, a stack should not rename or move files and folders of others without obtaining explicit confirmation from the user.

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 revDeleteFolder 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 revDeleteFolder command can be used in any handler.

Parameters:

  • folderToDelete: The folderToDelete 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.
  • The result: The revDeleteFolder 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.

See also: answer folder (command), delete file (command), revMoveFolder (command), folders (function), startup (message), openBackground (message), preOpenStack (message), openStack (message), preOpenCard (message), stack (object),

Advertisement