• Article

DefaultEvents.OnError Method

This event is raised by a task or container when an error occurs.

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

Syntax

'Declaration
Public Overridable Function OnError ( _
    source As DtsObject, _
    errorCode As Integer, _
    subComponent As String, _
    description As String, _
    helpFile As String, _
    helpContext As Integer, _
    idofInterfaceWithError As String _
) As Boolean
'Usage
Dim instance As DefaultEvents
Dim source As DtsObject
Dim errorCode As Integer
Dim subComponent As String
Dim description As String
Dim helpFile As String
Dim helpContext As Integer
Dim idofInterfaceWithError As String
Dim returnValue As Boolean

returnValue = instance.OnError(source, _
    errorCode, subComponent, description, _
    helpFile, helpContext, idofInterfaceWithError)

public virtual bool OnError(
    DtsObject source,
    int errorCode,
    string subComponent,
    string description,
    string helpFile,
    int helpContext,
    string idofInterfaceWithError
)

public:
virtual bool OnError(
    DtsObject^ source, 
    int errorCode, 
    String^ subComponent, 
    String^ description, 
    String^ helpFile, 
    int helpContext, 
    String^ idofInterfaceWithError
)

abstract OnError : 
        source:DtsObject * 
        errorCode:int * 
        subComponent:string * 
        description:string * 
        helpFile:string * 
        helpContext:int * 
        idofInterfaceWithError:string -> bool 
override OnError : 
        source:DtsObject * 
        errorCode:int * 
        subComponent:string * 
        description:string * 
        helpFile:string * 
        helpContext:int * 
        idofInterfaceWithError:string -> bool 

public function OnError(
    source : DtsObject, 
    errorCode : int, 
    subComponent : String, 
    description : String, 
    helpFile : String, 
    helpContext : int, 
    idofInterfaceWithError : String
) : boolean

Parameters

  • errorCode
    Type: System.Int32
    An integer that identifies the error message. This identifier should be unique when combined with the source parameter, so the source and errorCode combination should be unique. However, the errorCode alone is not expected to be unique.
  • subComponent
    Type: System.String
    An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.
  • helpFile
    Type: System.String
    The path to the Help file that contains detailed information.
  • helpContext
    Type: System.Int32
    Identifier of the topic in the Help file.
  • idofInterfaceWithError
    Type: System.String
    A textual representation of the GUID of the interface that caused the error.

Return Value

Type: System.Boolean
A Boolean that indicates whether the task should continue executing. A value of true indicates that the error should cause the task to cancel. A value of false indicates that the error should not stop the task from executing, but the task should continue.

Implements

IDTSEvents.OnError(DtsObject, Int32, String, String, String, Int32, String)