RenameFile Method

Renames the file.

Syntax

cloudstorage.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

This method renames an existing file on the server. The NewName parameter specifies the new name of the file.

Note: RenameFile is not supported when ServiceProvider is set to Amazon S3, Azure Blob, DigitalOcean, or Dropbox.

cloudstorage.RemotePath = "/MyFolder";
cloudstorage.RemoteFile = "file.txt";
cloudstorage.RenameFile("newfile.txt");