TElBaseArchive.OnProgress event

TElBaseArchive.OnProgress

Reports archive 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 arg0);
    TSBProgressEvent.Callback OnProgress = new TSBProgressEvent.Callback() {
        public void TSBProgressEventCallback(TObject Sender, long Total, long Current, TSBBoolean Cancel) {
            //...
        }
    }

Parameters

Total - Total amount of data to process in the current operation
Current - The amount of data that has been processed in the current operation
Cancel - set this parameter to TRUE to cancel the operation

Description

Use this event to notify the user and, if needd, to cancel the archive operation.

Discuss this help topic in SecureBlackbox Forum