Skip to main content

Rename File

Files & FoldersFilesWrites files

Renames a file in its current folder.

Inputs

NameTypeRequiredDefaultDescription
File
oldPath
fileRequired
New Name
newName
stringRequired
Overwrite Existing
overwriteExisting
booleanOptionalfalse
Output Variable
outputVariable
variableOptionalRenameResult

Output

$outputVariableObject

Object describing the rename result. Reference {RenameResult.newPath}, {RenameResult.oldPath}, {RenameResult.name}, {RenameResult.overwritten}, or {RenameResult} alone (resolves to the new full path).

  • successBoolean
  • oldPathString
  • newPathString
  • nameString
  • overwrittenBoolean
  • pathString

Compatibility

WindowsLinuxAttendedUnattended

Related activities