TElTarReader.OnProgress event

TElTarReader.OnProgress

This event reports extraction progress.

Declaration

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

[VB.NET]
Event OnProgress As TSBTarProgressEvent
Delegate Sub TSBTarProgressEvent(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 : TSBTarProgressEvent;
TSBTarProgressEvent = procedure(Sender : TObject; Processed, Total, OverallProcessed, OverallTotal : UInt64; var Cancel : boolean) of object;

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

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

[Java]
    TSBTarProgressEvent getOnProgress();
    void setOnProgress(TSBTarProgressEvent arg0);
    TSBTarProgressEvent.Callback OnProgress = new TSBTarProgressEvent.Callback() {
        public void TSBTarProgressEventCallback(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 TElTarReader periodically to show extraction progress. To abort extraction, set Cancel parameter to true.

Discuss this help topic in SecureBlackbox Forum