IDTSEvents100.OnError Method

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime.Wrapper

Assembly:

Microsoft.SqlServer.DTSRuntimeWrap.dll

Called by a task or container when an error occurs.

public:
 void OnError(Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSRuntimeObject100 ^ pSource, int ErrorCode, System::String ^ SubComponent, System::String ^ Description, System::String ^ HelpFile, int HelpContext, System::String ^ IDOfInterfaceWithError, [Runtime::InteropServices::Out] bool % pbCancel);

[System.Runtime.InteropServices.DispId(6)]
public void OnError (Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSRuntimeObject100 pSource, int ErrorCode, string SubComponent, string Description, string HelpFile, int HelpContext, string IDOfInterfaceWithError, out bool pbCancel);

[<System.Runtime.InteropServices.DispId(6)>]
abstract member OnError : Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSRuntimeObject100 * int * string * string * string * int * string * bool -> unit

Public Sub OnError (pSource As IDTSRuntimeObject100, ErrorCode As Integer, SubComponent As String, Description As String, HelpFile As String, HelpContext As Integer, IDOfInterfaceWithError As String, ByRef pbCancel As Boolean)

Parameters

pSource

IDTSRuntimeObject100

The source of the error, the object that caused the event.

ErrorCode

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

String

An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.

Description

String

The text of the message.

HelpFile

String

The path to the Help file that contains detailed information.

HelpContext

Int32

Identifier of the topic in the Help file.

IDOfInterfaceWithError

String

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

pbCancel

Boolean

true to cancel the error; otherwise, false.

Attributes

DispIdAttribute

Remarks

For more information, see IDTSEvents.