IDTSEvents100.OnError Method

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Called by a task or container when an error occurs.

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

Syntax

'Declaration
Sub OnError ( _
    pSource As IDTSRuntimeObject100, _
    ErrorCode As Integer, _
    SubComponent As String, _
    Description As String, _
    HelpFile As String, _
    HelpContext As Integer, _
    IDOfInterfaceWithError As String, _
    <OutAttribute> ByRef pbCancel As Boolean _
)
'Usage
Dim instance As IDTSEvents100 
Dim pSource As IDTSRuntimeObject100 
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 pbCancel As Boolean

instance.OnError(pSource, ErrorCode, SubComponent, _
    Description, HelpFile, HelpContext, _
    IDOfInterfaceWithError, pbCancel)

void OnError(
    IDTSRuntimeObject100 pSource,
    int ErrorCode,
    string SubComponent,
    string Description,
    string HelpFile,
    int HelpContext,
    string IDOfInterfaceWithError,
    out bool pbCancel
)

void OnError(
    [InAttribute] IDTSRuntimeObject100^ pSource, 
    [InAttribute] int ErrorCode, 
    [InAttribute] String^ SubComponent, 
    [InAttribute] String^ Description, 
    [InAttribute] String^ HelpFile, 
    [InAttribute] int HelpContext, 
    [InAttribute] String^ IDOfInterfaceWithError, 
    [OutAttribute] bool% pbCancel
)

abstract OnError : 
        pSource:IDTSRuntimeObject100 * 
        ErrorCode:int * 
        SubComponent:string * 
        Description:string * 
        HelpFile:string * 
        HelpContext:int * 
        IDOfInterfaceWithError:string * 
        pbCancel:bool byref -> unit

function OnError(
    pSource : IDTSRuntimeObject100, 
    ErrorCode : int, 
    SubComponent : String, 
    Description : String, 
    HelpFile : String, 
    HelpContext : int, 
    IDOfInterfaceWithError : String, 
    pbCancel : boolean
)

Parameters

• pSource
  Type: Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSRuntimeObject100
  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.

• pbCancel
  Type: System.Boolean%
  true to cancel the error; otherwise, false.

Remarks

For more information, see IDTSEvents.

See Also

Reference

IDTSEvents100 Interface

Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace