DirRename

Renames directories.

Function Group Execution Windows Embedded Thin Client
DirRename File Synchronous Supported Supported Executed on Server

Syntax

DirRename(strPath,strDirectoryFrom,strDirectoryTo)
strPath
The path of the directory that will be renamed.
Tip: This function supports wildcard ( * and ? ).
strDirectoryFrom
The original name of the directory that will be renamed.
strDirectoryTo
The target name used to rename the original directory.

Returned value

−1 Invalid parameters
0 Failed to rename the directory (e.g., strDirectoryFrom does not exist.)
1 Directory renamed successfully.

Examples

Tag Name Expression
Tag DirRename("C:\Studio\","Temp", "New") // C:\Studio\Temp is renamed to C:\Studio\New.