Crestron SIMPL+ - RemoveDirectory Function

Crestron SIMPL+
®
Software
Language Reference Guide - DOC. 5797G SIMPL+
®
z 181
RemoveDirectory
Name:
RemoveDirectory
Syntax:
SIGNED_INTEGER RemoveDirectory(STRING DirName)
Description:
Removes the directory with the specified name. The path name can be a relative link
or absolute, refer to page page 14. Must be empty. Requires StartFileOperations(),
refer to page page 183.
Parameters:
DIRNAME – string containing the name of the desired directory.
Return Value:
Returns 0 if successful and –1 if an error occurred.
Example:
(Refer to "File Functions Overview"on page 116)
IF( RemoveDirectory(“NewDirect”) < 0)
PRINT(“Error occurred deleting directory\n”);
Version:
SIMPL+ Version 3.00.02 or higher (Pro 2 only)
Control System:
2-Series Only