DefaultEvents.OnError Method

Article
12/03/2008

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

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
)

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

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

Parameters

source
The object that caused the event.

errorCode
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
An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.

description
The text of the message.

helpFile
The path to the Help file that contains detailed information.

helpContext
Identifier of the topic in the Help file.

idofInterfaceWithError
A textual representation of the GUID of the interface that caused the error.

Return Value

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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via