Back to product page

PutFile method


Sends file to the server.

Type

Void

Syntax

  • C#
  • VB.NET
public Void PutFile();

public Void PutFile(Stream FromStream);
The PutFile(FromStream) syntax has these parts:
FromStreamLocal stream that will be read by wodFtpDLX.NET.

public Void PutFile(String RemotePath);
The PutFile(RemotePath) syntax has these parts:
RemotePathFull path to filename where local file will be copied on server.

public Void PutFile(Stream FromStream, String RemoteFile);
The PutFile(FromStream,RemoteFile) syntax has these parts:
FromStreamLocal stream that will be read by wodFtpDLX.NET.
RemoteFileFull path to filename where local file will be copied on server.

public Void PutFile(String LocalFile, String RemotePath);
The PutFile(LocalFile,RemotePath) syntax has these parts:
LocalFileFull path to filename on your local disk.
RemotePathFull path to filename where local file will be copied on server.

public Sub PutFile()

public Sub PutFile(ByVal FromStream As Stream)
The PutFile(FromStream) syntax has these parts:
FromStreamLocal stream that will be read by wodFtpDLX.NET.

public Sub PutFile(ByVal RemotePath As String)
The PutFile(RemotePath) syntax has these parts:
RemotePathFull path to filename where local file will be copied on server.

public Sub PutFile(ByVal FromStream As Stream, ByVal RemoteFile As String)
The PutFile(FromStream,RemoteFile) syntax has these parts:
FromStreamLocal stream that will be read by wodFtpDLX.NET.
RemoteFileFull path to filename where local file will be copied on server.

public Sub PutFile(ByVal LocalFile As String, ByVal RemotePath As String)
The PutFile(LocalFile,RemotePath) syntax has these parts:
LocalFileFull path to filename on your local disk.
RemotePathFull 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 Args.Error with 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.NET is busy doing something else.

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

RemotePath = "/tmp"

in which case wodFtpDLX.NET 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.NET will use values set in LocalPath and RemotePath properties.

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

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