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

 

Called by a task or container when an error occurs.

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

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

Parameters

source
Type: Microsoft.SqlServer.Dts.Runtime.DtsObject

The source of the error, 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
Return to top
Show: