FileRemoveDir

Deletes a folder.

FileRemoveDir, DirName [, Recurse?]

Parameters

DirName

Name of the directory to delete, which is assumed to be in %A_WorkingDir% if an absolute path isn't specified.

Recurse?

0 (default): Do not remove files and sub-directories contained in DirName. In this case, if DirName is not empty, no action will be taken and ErrorLevel will be set to 1.

1: Remove all files and subdirectories (like the Windows command "rmdir /S").

This parameter can be an expression, even one that evalutes to true or false (since true and false are stored internally as 1 and 0).

ErrorLevel

[v1.1.04+] This command is able to throw an exception on failure. For more information, see Runtime Errors.

ErrorLevel is set to 1 if there was a problem or 0 otherwise.

Remarks

None

Related

FileCreateDir, FileDelete

Example

FileRemoveDir, C:\Download Temp
FileRemoveDir, C:\Download Temp, 1