33.17. $deleteDirectory

$deleteDirectory deletes a directory named directoryName. If the directory is to be deleted by a device MODULE other than the default disk device MODULE, the device prefix should be prepended to the directory name and separated from it by the STRING $devModBrkStr. For example, if $devModBrkStr is ">" and the directory foo/bar is to be deleted by a device MODULE D, directoryName should be "D>foo/bar".

If directoryName contains files, the files are also deleted. If directoryName contains directories, the directories are recursively deleted.

$deleteDirectory returns TRUE on success, FALSE on failure. If it fails, msg is set to an error message describing the failure.

Valid ctrlBits bits for $deleteDirectory are errorOK and $useOriginalFileName. If errorOK is set, then errMsg is not called when $deleteDirectory fails. If $useOriginalFileName is set, no logical file name or file searchpath substitution is performed on directoryName.

The interface of $deleteDirectory is subject to improvement if it proves unsatisfactory.