GetFile Method

Gets the specified file.

Syntax

rcp.getFile([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

This method gets the specified file. A connection is made with the RemoteHost using the specified Protocol, User, and Password, and a request is sent to read the file specified by RemoteFile.

Example (Get a File)

RCPControl.RemoteHost = "MyServer"
RCPControl.User = "username"
RCPControl.Password = "password"
RCPControl.Protocol = protRexec
RCPControl.RemoteFile = "/remotefile.txt"
RCPControl.LocalFile = "C:\filename.txt"
RCPControl.GetFile()