Equinox Online Help - Language Reference - A to Z

Home

RemoveDirectory

Applies to
SyntaxRemoveDirectory DirSpecExpression
Action[Statement] Removes an existing directory path.
ScopeUsable anywhere.
Notes

This statement removes a directory with the path specified by DirSpecExpression, if it exists and it is empty.

In order to remove a directory on the server, prepend “SERVER:” (in any case) to the DirSpecExpression. This prefix is ignored by the single user version. If the DirSpecExpression is a relative one, it will start from the program directory - the Eqserver.exe directory for server files, and the Equinox.exe or Equinet.exe directory for everything else.

The system workarea SysError is set to a non-zero value if an error occurs, otherwise zero.

CategoryFile Management
See Also ChooseFile, FileDelete, FileDetails, FileExists, FileHandle, FilePath, FileRename, FileSearch, FileSearchNext, MakeDirectory
Example

This example removes an existing, empty directory called "UNWANTED" from the C: drive.

RemoveDirectory "C:\EQUINOX\UNWANTED"