TElCustomDataStorage.OnProgress event

TElCustomDataStorage.OnProgress

Shows operation progress.

Declaration

[C#]
event TSBDataStorageProgressEvent OnProgress;
delegate void TSBDataStorageProgressEvent(Object Sender, TSBDataStorageOperation Operation, long Total, long Current, ref bool Cancel);

[VB.NET]
Event OnProgress As TSBDataStorageProgressEvent
Delegate Sub TSBDataStorageProgressEvent(ByVal Sender As Object, ByVal Operation As TSBDataStorageOperation, ByVal Total As Long, ByVal Current As Long, ByRef Cancel As Boolean)

[Pascal]
property OnProgress: TSBDataStorageProgressEvent;
TSBDataStorageProgressEvent = procedure(Sender : TObject; Operation : TSBDataStorageOperation; Total, Current : Int64; var Cancel : boolean) of object;

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

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

[Java]
    TSBDataStorageProgressEvent getOnProgress();
    void setOnProgress(TSBDataStorageProgressEvent Value);
    TSBDataStorageProgressEvent.Callback OnProgress = new TSBDataStorageProgressEvent.Callback() {
        public void TSBDataStorageProgressEventCallback(TObject Sender, TSBDataStorageOperation Operation, long Total, long Current, TSBBoolean Cancel) {
            //...
        }
    }

Parameters

Operation - specifies the operation being performed.
Total - total size of the data being transferred
Current - specifies how much data has been sent/received already
Cancel - allows to cancel the operation

Operation values:

[.NET] [C++]	[Pascal]	Description
dsoNone = 0	dsoNone	None
dsoRead = 1	dsoRead	Read
dsoWrite = 2	dsoWrite	Write
dsoList = 3	dsoList	List
dsoDelete = 4	dsoDelete	Delete
dsoCopy = 5	dsoCopy	Copy
dsoRename = 6	dsoRename	Rename
dsoReadInfo = 7	dsoReadInfo	Read info about objects or buckets.
dsoWriteInfo = 8	dsoWriteInfo	Write object or bucket info.
dsoOther = 9	dsoOther	Other
dsoLock = 10	dsoLock	…
dsoUnlock = 11	dsoUnlock	…

Description

This event is fired in order to show progress of the data storage operation.

Discuss this help topic in SecureBlackbox Forum