GetFile method will initiate copying of file residing on
remote server to the local computer. During the transfer,
Progress
event will be fired several times, depending on your
network speed and length of the file. When the copying is
completed, Done event will
be fired.
If an error occurs during transfer, Done event will
be fired immediately containing ErrorCode and description for the error, and
transfer will be aborted. If you want to continue it later,
or try to re-receive the file, initiate GetFile method
again (immediately or after reconnecting, depends on error
that occurred). You may also use Resume property to
resume transferring from the position where the error
occurred.
This method can be initiated only when State property is
set to Connected. You cannot receive file if wodFtpDLX is
busy doing something else.
Although RemoteFile argument
MUST contain full path including filename of the file you
wish to receive, you can omit LocalPath argument. For instance, you can
set
LocalPath = "C:\Temp"
in which case wodFtpDLX will automatically copy it with
the same name as it is on remote server. If you wish to
specify that is copied with some other name, you have to
include it in LocalPath
argument.
If you don't specify LocalPath or RemoteFile
argument, wodFtpDLX will use values set in LocalPath and RemotePath properties. If LocalPath is still empty (or
set to ""), then no local file will be used to write file to,
FileTransferData event will be fired instead where you read byte
array of data by yourself, and save it somewhere (or just ignore...
your choice).
No wildcards can be used for RemotePath argument. RFC protocol
specifications for FTP and SFTP do not allow them.
Do not forget that RemoteFile should always
specify full absolute path (i.e. /home/joe/something) instead of
relative path (i.e. joe/something). LocalPath should also specify
full path (i.e. C:\home\joe\something) instead of relative path
(i.e. joe\something).
GetFile Method
