FireDAC.Comp.BatchMove.TFDBatchMove.OnProgress

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property OnProgress: TFDBatchMoveProgressEvent read FOnProgress write FOnProgress;

C++

__property TFDBatchMoveProgressEvent OnProgress = {read=FOnProgress, write=FOnProgress};

Properties

Type Visibility Source Unit Parent
event published
FireDAC.Comp.BatchMove.pas
FireDAC.Comp.BatchMove.hpp
FireDAC.Comp.BatchMove TFDBatchMove

Description

Use the OnProgress event handler to provide a feedback to the end user during the data movement.

The event handler is called at the beginning and at the end of the data movement. It is also called after each StatisticsInterval read records, when StatisticsInterval is greater than 0. When StatisticsInterval is 0, then OnProgress is not called. Use ReadCount, WriteCount and other properties to get the statistic of the data movement operation.

The event handler receives the following argument:

  • APhase: Gives feedback about the status of the data movement: Preparing, Starting, Progress, Finishing and Unpreparing.

See Also