This is the documentation for the development version. There are no official binaries for it; build it from the source code in git. Download links on these pages work only after the release. For the current release, see version 7.0.

IO::RenameFile

IO::RenameFile(currentFile, newFileName): bool

Renames file.

In server scripts, IO:: functions are available only if server configuration variable NXSL.EnableFileIOFunctions is enabled (change requires server restart). They are always available in scripts run by nxscript.

In addition, a script that runs on behalf of a user (see Scripts Started by a User) needs the "Access server file system from scripts" system access right, and scripts in read-only script contexts cannot use IO:: functions while Scripts.RestrictWriteAccess is enabled. A denied call returns false without a script error.

Table 1. Parameters

currentFile

String

File to rename

newFileName

String

New file name

Return

TRUE if renamed was successful and FALSE if not.

IO::RenameFile("/tmp/oldFileName", "/tmp/mewFileName") // File with name "oldFileName" will be renamed to "mewFileName"