Renames a source file to a destination file, optionally overwriting the destination file if it already exists. Since this is a rename operation, after successful completion the source file will no longer exist.
0 |
File Path or Embedded File |
Source File Name |
The path for the source file. |
1 |
File Path or Embedded File |
Destination File Name |
The path for the destination file. |
2 |
Boolean |
Overwrite? |
Indicates whether the destination file should be overwritten if it already exists. |
None.
SUCCESS |
The file was successfully renamed. |
FAILURE |
The source file could not be found, or the source/destination path could not be accessed. |
This command supports both absolute paths (ex. C:\test.xit) and relative paths (ex. .\test.xit). If a rela- tive path is provided and the MP is embedded, the path will be relative to the current SA file location.
If the Overwrite? argument (Argument 2) is set to TRUE, and the destination file already exists, than the source file will be renamed over the destination file. If this argument is set to FALSE and the destination file already exists, no change will occur.