Export (0) Print
Expand All

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)

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

Parameters

source
Type: Microsoft.SqlServer.Dts.Runtime.DtsObject
The object that caused the event.
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.
description
Type: System.String
The text of the message.
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)

Community Additions

ADD
Show:
© 2014 Microsoft