Share via

IDTSComponentMetaData100.FireError Method

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:
Microsoft.SqlServer.DTSPipelineWrap.dll

Raises an OnError(IDTSRuntimeObject100, Int32, String, String, String, Int32, String, Boolean) event.

public:
 void FireError(int ErrorCode, System::String ^ SubComponent, System::String ^ Description, System::String ^ HelpFile, int HelpContext, [Runtime::InteropServices::Out] bool % pbCancel);
[System.Runtime.InteropServices.DispId(129)]
public void FireError (int ErrorCode, string SubComponent, string Description, string HelpFile, int HelpContext, out bool pbCancel);
[<System.Runtime.InteropServices.DispId(129)>]
abstract member FireError : int * string * string * string * int * bool -> unit
Public Sub FireError (ErrorCode As Integer, SubComponent As String, Description As String, HelpFile As String, HelpContext As Integer, ByRef pbCancel As Boolean)

Parameters

ErrorCode
Int32

The component-defined error code.

SubComponent
String

The name of the component that raises the event.

Description
String

The description of the error.

HelpFile
String

The help file that provides more information about the error event.

HelpContext
Int32

The context ID for the error.

pbCancel
Boolean

Specifies whether execution of the component is cancelled.

Attributes
DispIdAttribute

Remarks

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.

Applies to