Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
Optional flag. If omitted or if this parameter has the value 0, the directory is created only if all
previous directories exist. If this parameter has the value different from 0, the full path specified
in the strDirectory parameter is created.
Returned value
-1 Invalid parameters
0 Failed to create the directory (e.g., Drive does not exist.)
1 Directory created successfully.
Examples
Tag Name
Tag
Tag
Expression
DirCreate("C:\Studio\Temp") // The Temp folder is created in the C:\Studio path (only if the C:\Studio path
already exists).
DirCreate("C:\Studio\Temp",1) // The C:\Studio\Temp full path is created.
DirDelete
Deletes the specified directory.
Function Group Execution Windows Embedded Thin Client
DirDelete File Synchronous Supported Supported Executed on Server
Syntax
DirDelete( strDirectory, optBooEmptyOnly )
strDirectory
The name and file path of the directory to delete.
Tip: This parameter supports wildcards ( * and ).
optBooEmptyOnly
Optional flag. If this parameter has a value of 1, then the directory is deleted only if it is empty.
By default — that is, if the parameter is omitted or has a value of 0 — the directory is deleted
whether it is empty or not.
Returned value
Value
Description
−2 Attempted to delete a non-empty directory when this action is not allowed (i.e., optBooEmptyOnly does not equal 0).
−1
Invalid parameters.
0 Failed to delete the directory (i.e., directory does not exist).
1 Directory deleted successfully.
Examples
Tag Name
Tag
Expression
DirDelete( "C:\Studio\Temp" ) // The Temp folder from C:\Studio is deleted.
InduSoft Web Studio Page 627