Share via


IDTSComponentEvents100.FireProgress Method

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Raises an event when measurable progress is made by the executable.

Namespace:  Microsoft.SqlServer.Dts.Runtime.Wrapper
Assembly:  Microsoft.SqlServer.DTSRuntimeWrap (in Microsoft.SqlServer.DTSRuntimeWrap.dll)

Syntax

'Declaration
Sub FireProgress ( _
    ProgressDescription As String, _
    PercentComplete As Integer, _
    ProgressCountLow As Integer, _
    ProgressCountHigh As Integer, _
    SubComponent As String, _
    <OutAttribute> ByRef pbFireAgain As Boolean _
)
'Usage
Dim instance As IDTSComponentEvents100 
Dim ProgressDescription As String 
Dim PercentComplete As Integer 
Dim ProgressCountLow As Integer 
Dim ProgressCountHigh As Integer 
Dim SubComponent As String 
Dim pbFireAgain As Boolean

instance.FireProgress(ProgressDescription, _
    PercentComplete, ProgressCountLow, _
    ProgressCountHigh, SubComponent, _
    pbFireAgain)
void FireProgress(
    string ProgressDescription,
    int PercentComplete,
    int ProgressCountLow,
    int ProgressCountHigh,
    string SubComponent,
    out bool pbFireAgain
)
void FireProgress(
    [InAttribute] String^ ProgressDescription, 
    [InAttribute] int PercentComplete, 
    [InAttribute] int ProgressCountLow, 
    [InAttribute] int ProgressCountHigh, 
    [InAttribute] String^ SubComponent, 
    [InAttribute] [OutAttribute] bool% pbFireAgain
)
abstract FireProgress : 
        ProgressDescription:string * 
        PercentComplete:int * 
        ProgressCountLow:int * 
        ProgressCountHigh:int * 
        SubComponent:string * 
        pbFireAgain:bool byref -> unit
function FireProgress(
    ProgressDescription : String, 
    PercentComplete : int, 
    ProgressCountLow : int, 
    ProgressCountHigh : int, 
    SubComponent : String, 
    pbFireAgain : boolean
)

Parameters

  • ProgressDescription
    Type: System.String
    A String that describes the progress event that is raised.
  • PercentComplete
    Type: System.Int32
    An Integer used to indicate how much of the task has completed.
  • ProgressCountLow
    Type: System.Int32
    An Integer that contains the low 32-bits of the units completed.
  • ProgressCountHigh
    Type: System.Int32
    An Integer that contains the high 32-bits of the units completed.
  • SubComponent
    Type: System.String
    A String that contains more detail about the event source.
  • pbFireAgain
    Type: System.Boolean%
    When this method returns, contains a Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing. A value of false indicates that it should stop firing. This parameter is passed uninitialized.

See Also

Reference

IDTSComponentEvents100 Interface

Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace