RemotePath Property

The current path in the SFTP server.

Syntax

 sftp.getRemotePath([callback])
 sftp.setRemotePath( remotePath, [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 getRemotePath([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 setRemotePath([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 RemotePath shows the current working directory on the SFTP server. It can also be used to change the working directory by setting it to an absolute directory path, or a relative path with respect to the existing value of RemotePath.

If the first two bytes of the new path are "..", then a change to one level above in the directory tree is performed.

Setting RemotePath causes the class to send the appropriate command to the remote server only if connected.

Example (Changing Directory)

SFTPControl.Logon()
SFTPControl.RemotePath = "/home/user"

Data Type

String