Back to product page

PutFile method


Sends file to the server.

Type

None

Syntax

  • Basic
object.PutFile[LocalFile], [RemotePath]
The PutFile(object,LocalFile,RemotePath) syntax has these parts:
objectAn expression evaluating to an object of type wodFtpDLX.
LocalFileOptional. A Variant value. Full path to filename on your local disk. If left empty then FileTransferData event will be fired during file transfer.
RemotePathOptional. A Variant value. Full path to filename where local file will be copied on server.

Remarks

PutFile method will initiate copying of file residing on local computer to remote server you connected to. 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 resend the file, initiate PutFile 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 send file if wodFtpDLX is busy doing something else.

Although LocalFile argument MUST contain full path including filename of the file you wish to send, you can omit RemotePath argument. For instance, you can set
 
RemotePath = "/tmp"
 

in which case wodFtpDLX will automatically copy it with the same name as it is locally. If you wish to specify that is copied with some other name, you have to include it in RemotePath argument.

If you don't specify LocalFile or RemotePath 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 read file, FileTransferData event will be fired instead where you can specify new remote file contents.

No wildcards can be used for RemotePath argument. RFC protocol specifications for FTP or SFTP do not allow them.

You should consult SmartPut property regarding how is contents of RemotePath argument considered by wodFtpDLX - is it full path or it is only a folder...

Do not forget that RemotePath should always specify full absolute path (i.e. /home/joe/something) instead of relative path (i.e. joe/something). LocalFile should also specify full path (i.e. C:\home\joe\something) instead of relative path (i.e. joe\something).

Platforms

Windows