IDTSComponentMetaData100.FireError Método
Raises an OnError event.
Espacio de nombres: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Ensamblado: Microsoft.SqlServer.DTSPipelineWrap (en Microsoft.SqlServer.DTSPipelineWrap.dll)
Sintaxis
'Declaración
Sub FireError ( _
ErrorCode As Integer, _
SubComponent As String, _
Description As String, _
HelpFile As String, _
HelpContext As Integer, _
<OutAttribute> ByRef pbCancel As Boolean _
)
'Uso
Dim instance As IDTSComponentMetaData100
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
)
Parámetros
- ErrorCode
Tipo: System.Int32
The component-defined error code.
- SubComponent
Tipo: System.String
The name of the component that raises the event.
- Description
Tipo: System.String
The description of the error.
- HelpFile
Tipo: System.String
The help file that provides more information about the error event.
- HelpContext
Tipo: System.Int32
The context ID for the error.
- pbCancel
Tipo: System.Boolean%
Specifies whether execution of the component is cancelled.
Comentarios
An OnError event can be raised during package design or execution. During design time, errors are displayed in the Task List window and also cause a red X icon to be displayed next to the component shape on the designer surface. During execution, the error event may cause package execution to terminate.