TElSimpleSFTPClient.RenameFile method

TElSimpleSFTPClient.RenameFile

TElSimpleSFTPClient See also

Filter: C# VB.NET Pascal C++ PHP Java

Renames a file or folder on a server side.

Declaration

[C#]
void RenameFile(string OldPath, string NewPath);

[VB.NET]
Sub RenameFile(ByVal OldPath As String, ByVal NewPath As String)

[Pascal]
procedure RenameFile(const OldPath, NewPath : string);

[C++]
void RenameFile(const std::string &OldPath, const std::string &NewPath);

[PHP]
void RenameFile(string $OldPath, string $NewPath)

[Java]
void renameFile(String OldPath, String NewPath);

Parameters

OldPath - path to existing file
NewPath - specifies the new name/location of the file

Description

Use this method to rename the file specified by OldPath to the NewPath.
In case of error, EElSFTPError exception containing SFTP error code, is raised. For more information on error handling, please read the corresponding how-to article.