IDTSComponentMetaData90.FireError Method

Article
12/03/2008

Raises an OnError event.

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

Syntax

'Declaration
<DispIdAttribute(129)> _
Sub FireError ( _
    <InAttribute> ErrorCode As Integer, _
    <InAttribute> SubComponent As String, _
    <InAttribute> Description As String, _
    <InAttribute> HelpFile As String, _
    <InAttribute> HelpContext As Integer, _
    <OutAttribute> ByRef pbCancel As Boolean _
)

[DispIdAttribute(129)] 
void FireError (
    [InAttribute] int ErrorCode,
    [InAttribute] string SubComponent,
    [InAttribute] string Description,
    [InAttribute] string HelpFile,
    [InAttribute] int HelpContext,
    out bool pbCancel
)

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

/** @attribute DispIdAttribute(129) */ 
void FireError (
    /** @attribute InAttribute() */ int ErrorCode, 
    /** @attribute InAttribute() */ String SubComponent, 
    /** @attribute InAttribute() */ String Description, 
    /** @attribute InAttribute() */ String HelpFile, 
    /** @attribute InAttribute() */ int HelpContext, 
    /** @attribute OutAttribute() */ /** @ref */ boolean pbCancel
)

JScript does not support passing value-type arguments by reference.

Parameters

ErrorCode
The component-defined error code.

SubComponent
The name of the component that raises the event.

Description
The description of the error.

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

HelpContext
The context ID for the error.

pbCancel
Specifies whether execution of the component is cancelled.

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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms