Back to product page

GetFile method


Receives data from the server.

Type

None

Syntax

  • Basic
object.GetFile [LocalPath], [RemoteFile]
The GetFile(object,LocalPath,RemoteFile) syntax has these parts:
objectAn expression evaluating to an object of type wodSFTP.
LocalPathOptional. A Variant value. Full path to file/folder on local computer.
RemoteFileOptional. A Variant value. Full path to file on remote server.

Remarks

The GetFile method will initiate the copying of a file from the remote server to the local computer. During the transfer, the Progress event will be fired several times, depending on your network connection speed and size of the file. When the copy is complete, the Done event will be fired.

If an error occurs during the transfer, the Done event, containing ErrorCode and a description of the error, will be fired immediately and the transfer will be aborted. If you want to continue the transfer later, or you want to try to receive the file again, initiate the GetFile method again (immediately or after reconnecting, depending on which error occurred). You may also use the Resume property to resume the transfer from the position where the error occurred.

This method can be initiated only when the State property is set to Connected. You cannot receive a file if wodSFTP is busy doing something else.

Although the RemoteFile argument MUST contain the full path including the filename of the file you wish to receive, you can omit the LocalPath argument. For example, you can set

      LocalPath = "C:\Temp"

in which case wodSFTP will automatically copy it with the same name as it has on remote server. If you want to specify that is copied with another name, you should include it in the LocalPath argument.

If you don't specify the LocalPath or RemoteFile arguments, wodSFTP will use the values set in the LocalPath and RemotePath properties.

No wildcards can be used for the RemotePath argument. The RFC protocol specification for SFTP does not allow them.

In ASP we advise that you make the call as follows

      Sftp1.GetFile CStr(LocalPath), CStr(RemoteFile)

This will ensure that wodSFTP can read the optional string parameter correctly.

Platforms

Windows