Full path: /system/filesystem/delete
This function deletes a file from the path. When invoked from a simple execution step, this function deletes one file at a time. To delete multiple files with FlowForce, enclose the step which calls the delete function inside a For each step, as illustrated in the Copy Files example.
This function returns Boolean TRUE if execution was successful. If the job execution fails, the outcome depends on the value of the Abort on error parameter, as follows:
•If the Abort on error parameter is TRUE (default value), the job execution is aborted. In this case, you can still handle errors by means of protected blocks (see Handling Step Errors).
•If the Abort on error parameter is FALSE, the function returns FALSE.
| Note: | It is not possible for FlowForce to confirm directly from the delete function whether a file has been deleted. All FlowForce can do is get a response from the operating system that it is executing a delete command. If the job has subsequent steps that depend upon the deleted file, you will need to check explicitly whether the file still exists. You can you use the list-files function to check that. |
Parameters
Name |
Type |
Description |
|---|---|---|
Path |
string as directory |
The path and file name of the file you want to delete. |
Abort on error |
boolean |
This Boolean parameter determines what should be the return value of the function if the job fails. If Abort on error is FALSE, the function will return Boolean FALSE as well. If Abort on error is TRUE, the job execution is aborted. The default value is TRUE. |
Working directory |
string as directory |
Specifies the working directory (for example, c:\somedirectory). If relative paths are used, they will be resolved against the working directory. |
