IDTSEvents100.OnProgress Method

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

Called to update progress about task execution.

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

Syntax

'Declaration
Sub OnProgress ( _
    pTaskHost As IDTSTaskHost100, _
    ProgressDescription As String, _
    PercentComplete As Integer, _
    ProgressCountLow As Integer, _
    ProgressCountHigh As Integer, _
    SubComponent As String, _
    <OutAttribute> ByRef pbFireAgain As Boolean _
)
'Usage
Dim instance As IDTSEvents100 
Dim pTaskHost As IDTSTaskHost100 
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.OnProgress(pTaskHost, ProgressDescription, _
    PercentComplete, ProgressCountLow, _
    ProgressCountHigh, SubComponent, _
    pbFireAgain)

void OnProgress(
    IDTSTaskHost100 pTaskHost,
    string ProgressDescription,
    int PercentComplete,
    int ProgressCountLow,
    int ProgressCountHigh,
    string SubComponent,
    out bool pbFireAgain
)

void OnProgress(
    [InAttribute] IDTSTaskHost100^ pTaskHost, 
    [InAttribute] String^ ProgressDescription, 
    [InAttribute] int PercentComplete, 
    [InAttribute] int ProgressCountLow, 
    [InAttribute] int ProgressCountHigh, 
    [InAttribute] String^ SubComponent, 
    [InAttribute] [OutAttribute] bool% pbFireAgain
)

abstract OnProgress : 
        pTaskHost:IDTSTaskHost100 * 
        ProgressDescription:string * 
        PercentComplete:int * 
        ProgressCountLow:int * 
        ProgressCountHigh:int * 
        SubComponent:string * 
        pbFireAgain:bool byref -> unit

function OnProgress(
    pTaskHost : IDTSTaskHost100, 
    ProgressDescription : String, 
    PercentComplete : int, 
    ProgressCountLow : int, 
    ProgressCountHigh : int, 
    SubComponent : String, 
    pbFireAgain : boolean
)

Parameters

• pTaskHost
  Type: Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSTaskHost100
  A nulla null reference (Nothing in Visual Basic) value.

• 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%
  A Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing.

Remarks

For more information, see IDTSEvents.

See Also

Reference

IDTSEvents100 Interface

Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace