Encapsulates the AutoMate™ action in the “FTP” group, “FTP Rename.” The method attempts to rename a file on the FTP server.
Declaration
function FTPRename (varFTPOldName As Variant,
varFTPNewName As Variant,
intIncludeSubDirs As Integer) As Integer
Parameters
varFTPOldName
The full path of the file on the FTP server to be renamed.
varFTPNewName
The new name (including path, if relevant) of the file on the FTP server.
intIncludeSubDirs
If set to “0”, the rename command applies to only the current directory. If set to “1”, the rename command will go through all subdirectories as well.
Description
The FTPRename method attempts to rename a file on the FTP server specified by varFTPOldName to the filename varFTPNewName.
A connection to the FTP server must have been previously established by a successful called to FTPLogin.
NOTE: The Action2 FTP methods (with the exception of FTPQuickSend and FTPQuickRetrieve) may not function properly in the AutoMate™ BASIC IDE. To more accurately use these functions, run the script from within an AutoMate™ task using the “Run a BASIC Script” action.