SecureBlackbox 2020 Node.js Edition

Questions / Feedback?

RenameFile Method

Renames a file.

Syntax

sftpclient.renameFile(sourceFile, destFile, [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

Use this method to rename a remote file. Provide the old and the new name via SourceFile and DestFile parameters.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Node.js Edition - Version 20.0 [Build 8165]