Delete a file or a folder. Path is required for a successful operation.
- Recursive=false is the default behavior, and is usually used only for files.
EXEC DeleteObject Path=[directory1/file1.txt]
- Recursive=true is used when you want to delete a folder along with its content.
EXEC DeleteObject Path=[directory1], Recursive=true
- DeleteType=[FILES] is used when you want to delete only the files inside a folder. The sub folders will not be deleted. In this case, use Recursive=false (it is the default behavior).
EXEC DeleteObject Path=[directory1], DeleteType=[FILES]
- If you use DeleteType=[FILES] and Recursive=true:
EXEC DeleteObject Path=[directory1], DeleteType=[FILES], Recursive=truethen it would have the same effect as:
EXEC DeleteObject Path=[directory1], Recursive=trueIt is also slower, so it is not recommended.
|Path||String||The path of the file or folder to be deleted.|
|Recursive||Boolean|| Set this to true to delete a folder with all of it content.
The default value is false.
|DeleteType||String|| Set this to FILESANDFOLDERS to delete the file or folder specified in the Path parameter. Set this to FILES to delete only the files inside the folder specified in the Path parameter.
The allowed values are FILES, FILESANDFOLDERS.
The default value is FILESANDFOLDERS.
Result Set Columns
|Success||String||Determines if the operation was successful or not.|