DirRename
- Last UpdatedOct 29, 2026
- 2 minute read
Renames directories.
|
Function |
Group |
Execution |
String Exp. |
Windows |
Windows Embedded |
IoT View |
Thin Clients |
Mobile Access |
|---|---|---|---|---|---|---|---|---|
|
DirRename |
File |
Synchronous |
No |
Supported |
Supported |
Supported |
Executed on Server (see Notes below) |
Supported |
Syntax
DirRename ( strPath , strDirectoryFrom , strDirectoryTo )
strPath
The path of the directory that will be renamed.
Tip: This function supports wildcard ( * and ? ).
Note: Follow the conventions of the target platform for the file path and name, and separators. For example, a file path in Windows starts with a drive letter and uses backward slashes as separators (C:\path\to\file), while a file path in Linux starts at the root directory and uses forward slashes as separators (/path/to/file).
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 (for example, strDirectoryFrom does not exist.) |
|
1 |
Directory renamed successfully. |
Notes
By default, this function is executed on the project runtime server even when it is called in a screen on a project thin client, which means it only affects directories and files that are located on the server and all paths must be specified in that context. You can change the default behavior to force this function to be executed on the client where it is called, but if you do so, you must keep in mind that the change will affect not just this function but also several other File functions. To change the behavior of these functions, use a text editor to open your project file (<project name>.app) and then edit the following property:
[Options]
ExecuteFileFunctionsOnClient=1
Examples
|
Tag Name |
Expression |
|---|---|
|
Tag |
DirRename("C:\Studio\","Temp", "New") // C:\Studio\Temp is renamed to C:\Studio\New. |