• Article

IDTSComponentEvents.FireError Method

Raises an event when an error occurs.

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

Syntax

'Declaration
Function FireError ( _
    errorCode As Integer, _
    subComponent As String, _
    description As String, _
    helpFile As String, _
    helpContext As Integer _
) As Boolean
'Usage
Dim instance As IDTSComponentEvents
Dim errorCode As Integer
Dim subComponent As String
Dim description As String
Dim helpFile As String
Dim helpContext As Integer
Dim returnValue As Boolean

returnValue = instance.FireError(errorCode, _
    subComponent, description, helpFile, _
    helpContext)

bool FireError(
    int errorCode,
    string subComponent,
    string description,
    string helpFile,
    int helpContext
)

bool FireError(
    int errorCode, 
    String^ subComponent, 
    String^ description, 
    String^ helpFile, 
    int helpContext
)

abstract FireError : 
        errorCode:int * 
        subComponent:string * 
        description:string * 
        helpFile:string * 
        helpContext:int -> bool 

function FireError(
    errorCode : int, 
    subComponent : String, 
    description : String, 
    helpFile : String, 
    helpContext : int
) : boolean

Parameters

  • errorCode
    Type: System.Int32
    An Integer that identifies the error message.
  • subComponent
    Type: System.String
    A String that contains more detail about the event source.
  • helpFile
    Type: System.String
    The path to the Help file that contains detailed information.
  • helpContext
    Type: System.Int32
    The identifier of the topic in the Help file.

Return Value

Type: System.Boolean
A Boolean that indicates whether the event should continue firing or stop firing. A value of true indicates that the event should continue firing.

Remarks

Several of the events have a subComponent parameter that allows for even greater granularity in event source identification.