TElPGPWriter.OnProgress event

TElPGPWriter.OnProgress

This event is fired periodically to shows amount of processed data and ask if processing is continued.

Declaration

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

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

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

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

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

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

Parameters

Processed - amount of processed data in bytes.
Cancel - if this parameter is set to True, then further data processing will be canceled.
Total - ...

Description

This event notifies the application about the progress of data processing. The event handler receives the amount of processed data in bytes. To get amount of processed data in percents just count ((Processed * 100) / length_of_incoming_data).

Discuss this help topic in SecureBlackbox Forum