IPWorks SSH 2020 Node.js Edition

Questions / Feedback?

Upload Method

Upload a file specified by LocalFile to an SCP server.

Syntax

scp.upload([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 local file specified by LocalFile is uploaded to the remote file specified by RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to the server current directory;

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

Example


SCPControl.Localfile = "C:\localfile.txt"
SCPControl.RemoteFile = "remotefile.txt"
SCPControl.Download()

SCPControl.Localfile = "C:\localfile2.txt"
SCPControl.RemoteFile = "folder/remotefile2.txt"
SCPControl.Upload()

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 Node.js Edition - Version 20.0 [Build 8501]