Back to product page

PutFileAt method


Sends part of the file to the server.

Type

None

Syntax

  • Basic
object.PutFileAt LocalFile, RemotePath, RemotePosLo, RemotePosHi
The PutFileAt(object,LocalFile,RemotePath,RemotePosLo,RemotePosHi) syntax has these parts:
objectAn expression evaluating to an object of type wodSFTP.
LocalFileA Variant value. Full path to a file on local computer.
RemotePathA Variant value. Full path to a file/directory on the server.
RemotePosLoLong value. Low word of remote position.
RemotePosHiLong value. High word of remote position, defaults to 0.

Remarks

The PutFileAt method will initiate the copying of part of the file from the local computer to the remote server that you are connected to, at the specified position in the file. 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 transfer, the Done event containing the 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 resend the file, initiate the PutFileAt method again (immediately or after reconnecting, depending on which error occurred). You may NOT use the Resume property! If you want to continue a file transfer, increase the RemotePosLo/RemotePosHi arguments.

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

You can call this method as many times as you like, but if you plan to receive many chunks of data, try to specify larger chunks for each operation and make less calls. This is advisable because each PutFileAt call internally opens the remote file, writes data and closes the remote file, which when repeated many times may cause a performance problem.

Platforms

Windows