Rename Method

Description

Renames a file.

Syntax

Visual Basic
Public Sub Rename( _ ByVal FromFileName As String, _ ByVal ToFileName As String _ )

Parameters

FromFileName: Specifies the old file name and path.
ToFileName: Specifies the new file name and path.

Remarks

Sequences and sends the ftpRenameFrom and ftpRenameTo commands.

If Timeout is greater than 0, this method blocks until a reply is received from the server or a ptTimeout error occurs. If Timeout is 0, this method immediately returns and the Progress event fires with FtpCmd = ftpRenameTo when the reply is received.

Error Codes

This method may generate the following error code (refer to ErrorConstants for a complete list of error codes):

ptBlocked
ptConnectionAborted
ptConnectionReset
ptNetworkDown
ptNetworkReset
ptNoBufferSpace
ptNotConnected
ptProtocol
ptTimeout