Delete File (script step reference)

By May 1, 2017May 20th, 2020Online Help, Troi File Plug-in
Troi File Plug-in for FileMaker Pro

Delete File

Deletes the file indicated by the file path

SyntaxScript step badge

Delete File [ Select ; Result (error) ; filePath ]

Options

Select entire contentsreplaces 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
filePaththe path to the file to delete

Returned Result

Data type returned

Error code

Result

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:

0no errorThe file was deleted
$$-43fnfErrThe file was not found
$$-47fBsyErrThe file is in use
$$-1genericErrThe file could not be deleted

Other errors may be returned.

Originated in

Troi File Plug-in 9.0

Compatibility

FileMaker Pro 16 to 19

Considerations

WARNING: The file is not moved to the Trash, but deleted completely. This can not be undone!
See also the 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 “filewin:/C:/MyFiles/test.txt”.

Example

Assume your C disk already contains a file “TestFile.xls”. We assume that a global field gErrorCode is defined. Create the following script:

Delete File [ Select ; gErrorCode ; "C:\TestFile.xls" ]

This script will delete the file “TestFile.xls”. On Mac OS the path will be of the form “Mac HD:TestFile.xls”.

Example 2

We assume that in your FileMaker file the following fields are defined:

  gErrorCode		Global, number
  gFilePath		Global, text

gFilePath should contain the path to an existing file which you want to delete, for example “D:\Logs\Log01.TXT” (Windows) or “Mac HD:Logs:Log 1” (Mac). In a script add the following script step:

DeleteFile [ Select ; gErrorCode ;  gFilePath ]

This will delete the file from the disk.

Related script stepsScript step badge

Create File
Show Select File Dialog

Related functionFunction badge

TrFile_DeleteFile

Related topics

Troi File Plug-in online help (overview)


Online Help Page for Troi File Plug-in for 15 to 19 –> Delete File (filep7213) 2020-0520 15:39:15