MyChat Scripts Engine: DeleteFolder
Function for deleting a folder.
Syntax
function DeleteFolder(const sFolderName:string; bRecursive: boolean): integer;
Parameters and return values
|
Parameter |
Type |
Value |
|
sFolderName |
string |
a path to a folder you need to delete; |
|
bRecursive |
boolean |
recursive deleting of content in nested folders. If "false", then non-empty folders won't be deleted. |
Function result
|
Result |
Value |
|
0 |
all OK, folder was deleted successfully; |
|
-1 |
folder name you want to delete can't be empty; |
|
-2 |
folder does not exist; |
|
-3 |
folder deleting failure. |
Example
const
FOLDER_NAME = 'c:\temp\logs\today reports\';
var
iResult: integer;
s: string;
begin
iResult := DeleteFolder(FOLDER_NAME, true);
case iResult of
0: s := 'all ok, folder deleted';
-1: s := 'folder name cannot be empty';
-2: s := 'folder does not exist';
-3: s := 'error deleting folder';
end;
mLogScript(s, '');
end.
Script work result
[18:41:36] (Log "DeleteFolder"): all ok, folder deleted
[18:41:36] (Run "DeleteFolder"): Script operation time: 3 ms
[18:41:36] (Run "DeleteFolder"): Script done successfully.