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

RemotePath Property

The remote path on the server.

Syntax

 scp.getRemotePath([callback])
 scp.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 is either an absolute file path, or a relative path based on the server current directory.

This property specifies the remote path on the server when uploading or downloading.

This is required when using a filemask to upload multiple files.

In all other cases it is optional and path information may instead be specified in RemoteFile. If this is set, it is combined with RemoteFile to form a complete path to the file.

Multiple file uploads and downloads are supported through the use of filemasks.

To upload files matching a filemask set LocalFile to a local path including a filemask. Set RemotePath to the directory on the server where the files will be uploaded. In this case RemoteFile is ignored. All matching files will be upload when Upload is called. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers.

To download files matching a filemask set RemoteFile to a filemask. The path may be specified as part of the value in RemoteFile or may be set separately in RemotePath. LocalFile should be set to a local directory where files will be downloaded. When Download is called all matching files are downloaded. The StartTransfer, Transfer, and EndTransfer events provide details about the individual file transfers. In the event an individual file fails to transfer the Error event will fire.

Data Type

String

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