PackageUpgradeResult.OnError Method
This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.
Raises an event when an error occurs.
Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)
Syntax
'Declaration
Public 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
'Usage
Dim instance As PackageUpgradeResult
Dim source As DtsObject
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 returnValue As Boolean
returnValue = instance.OnError(source, _
errorCode, subComponent, description, _
helpFile, helpContext, idofInterfaceWithError)
public 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
) sealed
abstract OnError :
source:DtsObject *
errorCode:int *
subComponent:string *
description:string *
helpFile:string *
helpContext:int *
idofInterfaceWithError:string -> bool
override OnError :
source:DtsObject *
errorCode:int *
subComponent:string *
description:string *
helpFile:string *
helpContext:int *
idofInterfaceWithError:string -> bool
public final function OnError(
source : DtsObject,
errorCode : int,
subComponent : String,
description : String,
helpFile : String,
helpContext : int,
idofInterfaceWithError : String
) : 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.
- subComponent
Type: System.String
An arbitrary string that identifies the sub-module within a source.
- 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
The raised event.
Implements
IDTSEvents.OnError(DtsObject, Int32, String, String, String, Int32, String)