This method renames a file that exists on the FTP server. (It includes connecting to and disconnecting from the server.)
[Visual Basic] [ Boolean
=
]imagekitcontrolname.File.FTPRenameFile(ServerName As
String, ProxyName As String, PortNo As Integer, PassiveMode As
Boolean, RemoteOldFilePath As String, RemoteNewFile As String,
UserName As String, Password As String)
[Visual C++] [
BOOL =
]imagekitcontrolname.GetFile().FTPRenameFile(LPCTSTR
ServerName, LPCTSTR ProxyName, short PortNo, BOOL PassiveMode,
LPCTSTR RemoteOldFilePath, LPCTSTR RemoteNewFile, LPCTSTR UserName,
LPCTSTR Password)
[VB.NET] [ Boolean =
]imagekitcontrolname.File.FTPRenameFile(ServerName As
String, ProxyName As String, PortNo As Short, PassiveMode As
Boolean, RemoteOldFilePath As String, RemoteNewFile As String,
UserName As String, Password As String)
[C#.NET] [ bool =
]imagekitcontrolname.File.FTPRenameFile(string
ServerName, string ProxyName, short PortNo, bool PassiveMode,
string RemoteOldFilePath, string RemoteNewFile, string UserName,
string Password)
Parameters
| Name | Explanation |
|---|---|
| ServerName | The name of the FTP server or IPAddress |
| ProxyName | The Proxy Server IP Address |
| PortNo | Port Number (default is 21) |
| PassiveMode | Enables passive mode connectivity: False(0) = Active Mode Connection; True(nonzero) = Passive Mode Connection |
| RemoteOldFilePath | The old name of the file (The name and path of the file prior to renaming) |
| RemoteNewFile | The new name of the file (DOES NOT INCLUDE PATH) |
| UserName | The username needed to access the FTP server |
| Password | The password needed to access the FTP server |
Return Value
Returns True (nonzero) if successful. Returns False (0) if unsuccessful.
Explanation
The FTPRenameFile method renames a file that exists on the FTP server. (It includes connecting to and disconnecting from the server.) This method can only be executed from the client computer. It does not operate on the server.
When not using a proxy server set the ProxyName to an empty string, to vbNullString(Visual Basic), to NULL(Visual C++), to Nothing(VB.NET), or null(C#.NET).