Discuss this help topic in SecureBlackbox Forum

TElZipReader.OnProgress

TElZipReader     See also     


Filter: C#/Java  VB.NET  Pascal  C++  PHP  


This event reports extraction progress.

Declaration

[C#/Java]
    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
    Public Delegate Sub TSBZipProgressEvent(ByVal Sender As Object, ByVal Processed As ULong, ByVal Total As ULong, ByVal OverallProcessed As ULong, ByVal OverallTotal As ULong, 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)

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 continuously to show extraction progress. Parameter Cancel could be set to True in order to stop operation.

See also:     OnExtractionFinished     OnExtractionStart    

Discuss this help topic in SecureBlackbox Forum