TElBZip2Reader.OnProgress event

TElBZip2Reader.OnProgress

This event reports extraction progress.

Declaration

[C#]
event TSBBzip2ProgressEvent OnProgress;
delegate void TSBBzip2ProgressEvent(Object Sender, ulong Processed, ulong Total, ref bool Cancel);

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

[Pascal]
property OnProgress : TSBBzip2ProgressEvent;
TSBBzip2ProgressEvent = procedure(Sender : TObject; Processed, Total : UInt64; var Cancel : boolean) of object;

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

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

[Java]
    TSBBzip2ProgressEvent getOnProgress();
    void setOnProgress(TSBBzip2ProgressEvent arg0);
    TSBBzip2ProgressEvent.Callback OnProgress = new TSBBzip2ProgressEvent.Callback() {
        public void TSBBzip2ProgressEventCallback(TObject Sender, long Processed, long Total, TSBBoolean Cancel) {
            //...
        }
    }

Parameters

Processed - number of processed bytes of the current entry.
Total - total size of the data being processed.
Cancel - this parameter allows to cancel data extraction.

Description

This event is fired by TElBZip2Reader periodically to show extraction progress. To abort extraction, set Cancel parameter to true.