IDTSComponentEvents100.FireError 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.Wrapper
Assembly: Microsoft.SqlServer.DTSRuntimeWrap (in Microsoft.SqlServer.DTSRuntimeWrap.dll)
Syntax
'Declaration
Sub FireError ( _
ErrorCode As Integer, _
SubComponent As String, _
Description As String, _
HelpFile As String, _
HelpContext As Integer, _
<OutAttribute> ByRef pbCancel As Boolean _
)
'Usage
Dim instance As IDTSComponentEvents100
Dim ErrorCode As Integer
Dim SubComponent As String
Dim Description As String
Dim HelpFile As String
Dim HelpContext As Integer
Dim pbCancel As Boolean
instance.FireError(ErrorCode, SubComponent, _
Description, HelpFile, HelpContext, _
pbCancel)
void FireError(
int ErrorCode,
string SubComponent,
string Description,
string HelpFile,
int HelpContext,
out bool pbCancel
)
void FireError(
[InAttribute] int ErrorCode,
[InAttribute] String^ SubComponent,
[InAttribute] String^ Description,
[InAttribute] String^ HelpFile,
[InAttribute] int HelpContext,
[OutAttribute] bool% pbCancel
)
abstract FireError :
ErrorCode:int *
SubComponent:string *
Description:string *
HelpFile:string *
HelpContext:int *
pbCancel:bool byref -> unit
function FireError(
ErrorCode : int,
SubComponent : String,
Description : String,
HelpFile : String,
HelpContext : int,
pbCancel : boolean
)
Parameters
- ErrorCode
Type: System.Int32
An Integer that identifies the error message.
- SubComponent
Type: System.String
A String that contains more detail about the event 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
The identifier of the topic in the Help file.
- pbCancel
Type: System.Boolean%
When this method returns, contains a Boolean that indicates whether the event should continue firing or stop firing. A value of true indicates that the event should continue firing. A value of false indicates that the event should stop firing. This parameter is passed uninitialized.