TElZipReader.OnProgress event

TElZipReader.OnProgress

This event reports extraction progress.

Declaration

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

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

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

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

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

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

Parameters

Processed - number of processed bytes of the current entry
Total - total size of the current archive entry.
OverallProcessed - number of bytes processed of the whole archive.
OverallTotal - total size of the archive in bytes.
Cancel - this parameter allows to cancel data extraction.

Description

This event is fired by TElZipReader periodically to show extraction progress. Parameter Cancel could be set to True in order to stop operation.

Discuss this help topic in SecureBlackbox Forum