TElSimpleSFTPClient.OnProgress event

TElSimpleSFTPClient.OnProgress

This event is fired during data reading/writing to report operation progress.

Declaration

[C#]
event TSBProgressEvent OnProgress;
delegate void TSBProgressEvent(Object Sender, long Total, long Current, ref bool Cancel);

[VB.NET]
Event OnProgress As TSBProgressEvent
Delegate Sub TSBProgressEvent(ByVal Sender As Object, ByVal Total As Long, ByVal Current As Long, ByRef Cancel As Boolean)

[Pascal]
property OnProgress : TSBProgressEvent;
TSBProgressEvent = procedure(Sender : TObject; Total, Current : Int64; var Cancel : boolean) of object;

[C++]
    void get_OnProgress(TSBProgressEvent &pMethodOutResult, void * &pDataOutResult);
    void set_OnProgress(TSBProgressEvent pMethodValue, void * pDataValue);
    typedef void (SB_CALLBACK *TSBProgressEvent)(void * _ObjectData, TObjectHandle Sender, int64_t Total, int64_t Current, int8_t &Cancel);

[PHP]
    TSBProgressEvent|callable|NULL get_OnProgress()
    void set_OnProgress(TSBProgressEvent|callable|NULL $Value)
    callable TSBProgressEvent(TObject $Sender, integer $Total, integer $Current, bool &$Cancel)

[Java]
    TSBProgressEvent getOnProgress();
    void setOnProgress(TSBProgressEvent Value);
    TSBProgressEvent.Callback OnProgress = new TSBProgressEvent.Callback() {
        public void TSBProgressEventCallback(TObject Sender, long Total, long Current, TSBBoolean Cancel) {
            //...
        }
    }

Parameters

Total - file total size
Current - specifies how much data has been downloaded/uploaded already
Cancel - allows to cancel the operation

Description

This event is fired by TElSimpleSFTPClient in order to show download/upload progress.