The OnProgress Event indicates the progress of a task.
object.OnProgress(
EventSource,
ProgressDescription,
PercentComplete,
ProgressCountLow,
ProgressCountHigh)
| Part | Description |
|---|---|
| Package | An expression that evaluates to an object in the Applies To list |
| EventSource | Event being executed |
| ProgressDescription | Description of task progress |
| PercentComplete | Percent of task completed |
| ProgressCountLow | Low 32 bits of units (for example, rows) completed |
| ProgressCountHigh | High 32 bits of units (for example, rows) completed |
If the percent completed cannot be reported, 0 is returned. It is not necessary for CustomTask objects to call this event if no progress can be reported.
For task types defined by DTS, the EventSource argument indicates a task by name. DTS tasks can be unnamed. When an unnamed task raises an OnProgress event, the EventSource argument is empty.
HRESULT OnProgress(BSTR EventSource,
BSTR ProgressDescription,
long PercentComplete,
long ProgressCountLow,
long ProgressCountHigh);