TElFTPSServer.OnTransferProgress event

TElFTPSServer.OnTransferProgress

This event is fired periodically to report transfer progress.

Declaration

[C#]
event TSBFTPSServerTransferProgressEvent OnTransferProgress;
delegate void TSBFTPSServerTransferProgressEvent(Object Sender, long Progress, long Total, ref bool Abort);

[VB.NET]
Event OnTransferProgress As TSBFTPSServerTransferProgressEvent
Delegate Sub TSBFTPSServerTransferProgressEvent(ByVal Sender As Object, ByVal Progress As Long, ByVal Total As Long, ByRef Abort As Boolean)

[Pascal]
property OnTransferProgress : TSBFTPSServerTransferProgressEvent;
TSBFTPSServerTransferProgressEvent = procedure (Sender: TObject; Progress, Total : Int64; var Abort : boolean) of object;

[C++]
    void get_OnTransferProgress(TSBFTPSServerTransferProgressEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnTransferProgress(TSBFTPSServerTransferProgressEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBFTPSServerTransferProgressEvent)(void * _ObjectData, TObjectHandle Sender, int64_t Progress, int64_t Total, int8_t &Abort);

[PHP]
    TSBFTPSServerTransferProgressEvent|callable|NULL get_OnTransferProgress()
    void set_OnTransferProgress(TSBFTPSServerTransferProgressEvent|callable|NULL $Value)
    callable TSBFTPSServerTransferProgressEvent(TObject $Sender, integer $Progress, integer $Total, bool &$Abort)

[Java]
    TSBFTPSServerTransferProgressEvent getOnTransferProgress();
    void setOnTransferProgress(TSBFTPSServerTransferProgressEvent Value);
    TSBFTPSServerTransferProgressEvent.Callback OnTransferProgress = new TSBFTPSServerTransferProgressEvent.Callback() {
        public void TSBFTPSServerTransferProgressEventCallback(TObject Sender, long Progress, long Total, TSBBoolean Abort) {
            //...
        }
    }

Parameters

Progress - contains the number of bytes transferred.
Total - total number of bytes to be transferred (file size).
Abort - set this parameter to True to cancel transfer.

Description

This event is fired by TElFTPSServer to report status of current data transfer (file upload/download). You can use parameter Abort to cancel the transfer. In such case OnAbortTransfer event will be fired.

Discuss this help topic in SecureBlackbox Forum