Transfer Event

Fired during file download/upload.

Syntax

typedef void __fastcall (__closure *TiphSFTPTransferEvent)(System::TObject* Sender, TiphSFTPTransferEventParams *e);

__property TiphSFTPTransferEvent OnTransfer = {read=FOnTransfer, write=FOnTransfer};

typedef struct {
     int Direction;
     String LocalFile;
     String RemoteFile;
     __int64 BytesTransferred;
     int PercentDone;
     String Text;
     bool Cancel;
} TiphSFTPTransferEventParams;

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

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

LocalFile identifies the local file. RemoteFile is the remote file.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

To cancel the current transfer set Cancel to true.