RenameFile Method

Change the name of RemoteFile to NewName .

Syntax

sftp.renameFile(newName, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

The name of remote file or folder specified by RemoteFile is changed to NewName. RemoteFile and NewName are either absolute paths on the server, or a path relative to RemotePath.

If there is no SSH session in place, one is automatically created by first.