|
Summary
Retrieve file from server.
Syntax
| Boolean GetFile (RemoteFile, LocalFile) |
| |
RemoteFile |
String |
| |
LocalFile |
String |
Description
Files can be transferred to and from the FTP server either directly or through events depending on the setting of the TransferMode property or the call to the EventMode or FileMode method.
The GetFile method takes a remote file name (RemoteFile) and a local file name (LocalFile) as its parameters and returns a boolean. For an event based file transfer, pass an empty
string as the local file parameter. If the file was successfully transferred, then the method returns True; otherwise, it returns False. The application should ensure that the method was successfully
executed by checking the return value. The method also sets the LastResult property. The value of the LastResult property can be checked to determine if any error occurred.
To do a direct file transfer you need to call the FileMode method first. In direct mode, a call to the GetFile method transfers the remote file to the local file. The remote file and the local file
are passed as parameters to this method. This feature allows an application to transfer complete files of any size without doing any I/O itself. The local file parameter passed must contain a fully
qualified path name since there is no current local directory.
To do an event based transfer, you must call EventMode first. If you have binary data to transmit, set the UseVariant peroperty to TRUE. This will fire the ONReceiveB event to deliver the data
instead of OnReceive. When a file is transferred through events, then one or more OnReceive events will be fired. An OnReceive event delivers a portion of the data from the remote file to the
application. Event based file transfer allows an application to move data to and from storage other than the local disk, such as through DDE or the clipboard. For event based file transfer, the local
file parameter is ignored and can be left blank.
Calling this method is equivalent to setting the FileAction property to FILE_ACTION_GET.
Note
Prior to this command, the Ascii or Binary methods should be called.
Example
Result = FTPClient.GetFile ("test.exe", "c:\test.exe")
If Result = False Then
MsgBox "Cannot get file from server", 64, "Sample Program"
End
If
| 
