delete file
Delete a file.
Name | Description | Type | Modifier |
---|---|---|---|
file | Full path of target file. | String | None |
force | (Optional) Force the file to be deleted (see ). Allowable values:
| Value Set | true, false |
None
This action may be used within the following project items: test modules and user-defined actions.
file
check file exists d:\Example.txt
 
file force
delete file d:\Example.txt false
 
file
check file exists d:\Example.txt
 
file
check file exists c:\Sample.txt
 
file force
delete file c:\Sample.txt true
 
file
check file exists c:\Sample.txt
- Observe the following format for the file path:
- Windows platform: Use backward slashes as separators for the path.
- Linux platform: Use forward slashes as separators for the path. (Note that network paths are not supported)
- Note that this built-in action is not currently supported on macOS or mobile platforms.
- Forced deletion is only successful under certain circumstances in which the program would otherwise have insufficient permission for deletion (e.g., a read-only file). However, delete file does not force deletion of a file that has been locked by another process.
- A warning is issued if the file specified in file is not found to exist.
- This action supports the <ignore> modifier. If the string
<ignore>
is present as the value of any of the arguments, or any argument contains an expression that evaluates to<ignore>
, the action is skipped during execution.