Deletes the folder indicated by the folderPath.
Delete Folder [ Select ; Result (error) ; FolderPath ; Delete all subfolders ]
|Select entire contents||replaces the contents of a field with the result. If not checked the result replaces the currently selected portion of the field|
|Result (error)||an error code|
|FolderPath||the path to the folder to delete|
|Delete all subfolders||delete all sub folders and also the contents of those folders|
Data type returned
The returned result is an error code. An error always starts with 2 dollars, followed by the error code. You should always check for errors. Returned error codes can be:
|0||no error||the folder was deleted|
|$$-1||the user cancelled the action|
|$$-37||bdNamErr||bad name in the file system|
|$$-47||fBsyErr||file is busy, can’t delete because the folder is not empty|
|$$-50||paramErr||parameter error, check if the supplied parameters are correct|
|$$-120||dirNFErr||directory not found, is not a directory or is a file|
Other errors may be returned.
Troi File Plug-in 9.0
FileMaker Pro 16 to 19
WARNING This is a powerful feature. Be careful what you do! Note also that the folder is not moved to the Trash, but deleted completely. This can not be undone!
See also Dial_Dialog function (of the Troi Dialog plug-in) or use the “Show Message” script step if you want to warn the user.
You can use FileMaker styled paths, like “filemac:/MacHD/folder/subfolder”.
Assume your C disk already contains a folder “Test Directory”. We assume that a global number field gErrorCode is defined. Create the following script:
Delete Folder [ Select ; $ErrorCode ; "-Unused " ; " C:\Test Directory\" ]
This script will delete the folder “Test Directory”. On macOS the path will be of the form “Mac HD:Test Directory:”.
We assume that in your FileMaker file the following fields are defined:
gErrorCode Global, number gFolderPath Global, text
gFolderPath should contain the path to an existing folder which you want to delete, for example “D:\Logs\” (Windows) or “Mac HD:Logs:” (Mac). In a script add the following scriptstep:
Delete Folder [ Select ; gErrorCode ; gFolderPath ; Delete all subfolders ]
This will delete the folder from the disk, including contents, like files and folders. The user is always given a warning. If you don’t use ‘Delete all subfolders’ only empty folders are deleted.
Related script steps
|Show Select Folder Dialog|