|
Summary
Append to a file on server.
Syntax
| Boolean AppendFile (LocalFile, RemoteFile) |
| |
LocalFile |
String |
| |
RemoteFile |
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 AppendFile method takes a local file name (LocalFile) and a remote file name (RemoteFile) 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.
In direct mode, a call to the AppendFile method will append the contents of the local file to the remote file. The local file and the remote 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.
When a file is transferred through events, then one or more OnSend events will be fired. An OnSend event asks the application to provide up to a maximum number of bytes of data, which are to be saved
in the remote file. OnSend events are generated until the application indicates that there is no more data to send. 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_APPEND.
Example
Result = FTPClient.AppendFile ("c:\test.exe", "test.exe") If Result = False Then MsgBox "Cannot append to file on server", 64, "Sample Program"
End If
|