OnProgress event/delegate/callback
Filter:
Pascal DLL C++ (DLL/Lib) C++ (VCL) C++ (.NET) C# VB.NETOverview
This event is fired when storage needs to be created.
Declaration
[Pascal]
TSolFSProgressEvent = procedure(
Sender : TObject;
Operation : LongWord;
Progress : LongWord;
Total : LongWord;
CanStop : Boolean;
var Stop : Boolean) of object;
[DLL]
typedef Error (__stdcall *SolFSProgressFunc)(
CallbackDataType UserData,
unsigned long Operation,
unsigned long Progress,
unsigned long Total,
bool CanStop,
bool *Stop);
[C++ (DLL/Lib)]
typedef Error (__stdcall *SolFSProgressFunc)(
CallbackDataType UserData,
unsigned long Operation,
unsigned long Progress,
unsigned long Total,
bool CanStop,
bool *Stop);
[C++ (VCL)]
typedef void (__closure *TSolFSProgressEvent)(
System::TObject* Sender,
unsigned long Operation,
unsigned long Progress,
unsigned long Total,
bool CanStop,
bool &Stop);
[C++ (.NET)]
public __delegate void SolFSProgressEvent(
SolFSStorage* Sender,
unsigned long Operation,
unsigned long Progress,
unsigned long Total,
boolean CanStop,
boolean __gc &Stop);
[C#]
public void SolFSProgressEvent(
SolFS.SolFSStorage Sender,
uint Operation,
uint Progress,
uint Total,
bool CanStop,
ref bool Stop);
[VB.NET]
Sub SolFSProgressEvent(
ByVal Sender As SolFS.SolFSStorage,
ByVal Operation As UInt32,
ByVal Progress As UInt32,
ByVal Total As UInt32,
ByVal CanStop As Boolean,
ByRef Stop As Boolean)
Parameters
- Sender - reference to the class that called the delegate/event handler.
- Operation - the code of operation being performed.
- Progress - current progress.
- Total - maximum progress. Can be 0 if it can't be determined.
- CanStop - specifies is the operation can be interrupted by the user. The value can be different during one operation
- Stop - set this parameter to true to stop current operation
- [DLL] UserData - application-defined parameter which is specified when the operation is invoked and passed back to callback function.
Description
The event is fired when some lengthy operation is performed. Note, that certain operations can be repeated many times, so the same operation code can be reported several times in Operation parameter.
See also
Information about callbacks (Driver Edition only) CheckAndRepair FormatFixedSize