RemoteFile Property

The name of the remote file for uploading, downloading, etc.

Syntax

 ftp.getRemoteFile([callback])
 ftp.setRemoteFile( remoteFile, [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 getRemoteFile([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 setRemoteFile([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

This property contains the name of the remote file to upload, download, etc. and is either an absolute file path, or a relative path based on RemotePath.

A number of methods use RemoteFile as an argument.

Example (Setting RemoteFile)

FTPControl.LocalFile = "C:\localfile.txt"
FTPControl.RemoteFile = "remotefile.txt"
FTPControl.Download()

FTPControl.LocalFile = "C:\localfile2.txt"
FTPControl.RemoteFile = "folder/remotefile2.txt"
FTPControl.Download()

Note: This property will also act as a file mask when performing ListDirectory or ListDirectoryLong.

Example (Using RemoteFile as a file mask):

FTPControl.RemoteFile = "*.txt"
FTPControl.ListDirectory()

The RemoteFile property supports several pattern matching characters. The following special characters are supported for pattern matching:

If the above characters need to be used as a literal in a FileMask then they must be escaped by surrounding them with a []. (Note, "]" and "-" do not need to be escaped) See below for the escape sequences:

For example, if you wanted to download a file whose name was [Something].txt you could set the RemoteFile property to: [[]Something].txt

Data Type

String