IDTSComponentMetaData100::FireError Method (Int32, String^, String^, String^, Int32, Boolean%)

 

Raises an OnError event.

Namespace:   Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)

[DispIdAttribute(129)]
void FireError(
	int ErrorCode,
	String^ SubComponent,
	String^ Description,
	String^ HelpFile,
	int HelpContext,
	[OutAttribute] bool% pbCancel
)

Parameters

ErrorCode
Type: System::Int32

The component-defined error code.

SubComponent
Type: System::String^

The name of the component that raises the event.

Description
Type: System::String^

The description of the error.

HelpFile
Type: System::String^

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

HelpContext
Type: System::Int32

The context ID for the error.

pbCancel
Type: System::Boolean%

Specifies whether execution of the component is cancelled.

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.

Return to top
Show: