Export (0) Print
Expand All

IDTSComponentMetaData100.FireError Method

Raises an OnError event.

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

function FireError(
	ErrorCode : int, 
	SubComponent : String, 
	Description : String, 
	HelpFile : String, 
	HelpContext : int, 
	pbCancel : boolean
)

Parameters

ErrorCode
Type: Int32
The component-defined error code.
SubComponent
Type: String
The name of the component that raises the event.
Description
Type: String
The description of the error.
HelpFile
Type: String
The help file that provides more information about the error event.
HelpContext
Type: Int32
The context ID for the error.
pbCancel
Type: 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.

Community Additions

ADD
Show:
© 2014 Microsoft