Back to product page

AppendFile method


Appends to a remote file.

Type

None

Syntax

  • Basic
object.AppendFile[LocalFile], [RemotePath]
The AppendFile(object,LocalFile,RemotePath) syntax has these parts:
objectAn expression evaluating to an object of type wodSFTP.
LocalFileOptional. A Variant value. Full path to file on local computer.
RemotePathOptional. A Variant value. Full path to file/directory on the server.

Remarks

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

AppendFile cannot be used when the Resume property is set to True.

If an error occurs during the transfer, the Done event , containing ErrorCode and the description of the error, will be fired immediately and the transfer will be aborted. This method can be initiated only when the State property is set to Connected. You cannot send a file if wodSFTP is busy doing something else.

Although the LocalFile argument MUST contain the full path, including the filename of the file you wish to send, you can omit the RemotePath argument. For example, you can set

    RemotePath = "/tmp"

in which case wodSFTP will automatically copy it using the same name as it has locally. If you wish to specify that is to be copied with a different name, you should include it in the RemotePath argument.

If you don't specify the LocalFile or RemotePath 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 specifications for SFTP does not allow them.

Platforms

Windows