Transfer Event

Fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, OftpclientTransferEventArgs e);

public class OftpclientTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string LocalFile { get; }
  public string VirtualFileName { get; }
  public string VirtualFileDate { get; }
  public string Destination { get; }
  public string Originator { get; }
  public long BytesTransferred { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As OftpclientTransferEventArgs)

Public Class OftpclientTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property LocalFile As String
  Public ReadOnly Property VirtualFileName As String
  Public ReadOnly Property VirtualFileDate As String
  Public ReadOnly Property Destination As String
  Public ReadOnly Property Originator As String
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

Remarks

The Text parameter contains the portion of the document text being retrieved. It is empty if data is being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.