• Article

ReportProgress (clsDatabase)

Note

  This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.

This event is called to report progress during a processing action.

Applies To:clsDatabase

Syntax

ReportProgress(obj As Object, ByVal Action As Integer, Counter As Long, Message As String, Cancel as Boolean)

Parameters

  • obj
    Refers to the object being processed or the target object of the action.

  • Action
    Refers to the processing action that has been completed.

  • Counter
    Indicates the numerical progress of the operation referred to by Action. For cubes, this argument refers to the number of rows that have been processed. For data mining models, this argument contains a number between 0 and 100 indicating the percentage of the processing task that has been completed.

  • Message
    A user-friendly message describing the progress made.

  • Cancel
    Allows the application to cancel an action by setting this parameter to True.

Remarks

This event can be used to update a progress bar or counter in a user interface. When using a progress bar to track the progress of a cube that is being processed, the maximum value of the progress bar is determined by the cube's EstimatedRows property. For tracking the progress of a data mining model, set the maximum value of the progress bar to 100. When processing a cube this event will be fired every 1000 rows. For data mining models this interval is inconsistent and cannot be determined in advance.

For more information about using this event, see Events.