IP*Works! SSH V9 - Online Help
IP*Works! SSH V9
Questions / Feedback?

LocalFile Property

The path to a local file for download/upload. If the file exists, it is overwritten.

Syntax

 sftp.getLocalFile([callback])
 sftp.setLocalFile( localFile, [callback])

Default Value

""


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 the getLocalFile([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setLocalFile([callback]) 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 LocalFile property is used by the Upload and Download methods. See the method descriptions for more information.

Example (Setting LocalFile)


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

SFTPControl.Localfile = "C:\localfile2.txt"
SFTPControl.RemoteFile = "folder/remotefile2.txt"
SFTPControl.Download()

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0