remove_dir

The remove_dir function deletes a directory. The directory is specified using its full path, for example, a string or value equal to "D:\\data\\2022-06-14\\data". Note that Windows directory components must be separated by the '\\' or '/' characters.

Syntax

bSuccess, sMsg = remove_dir( sFullPath )

    sFullPath is the full path name for the directory to be deleted.

    bSuccess is true if the function is successful or false if not.

    sMsg is an optional message string that recieves information about the failure.

Remarks

This function will fail if the current directory is the one to be removed. If the target directory cannot be deleted, remove_dir will fail and return false plus an error message. You can use is_dir to test whether the directory was deleted.

Related Topics

Directory Functions, change_dir, make_dir, get_dir, remove_file

Mira Pro x64 Script User's Guide, v.8.73 Copyright Ⓒ 2024 Mirametrics, Inc. All Rights Reserved.