IDTSComponentEvents.FireError Method

Article
12/03/2008

Raises an event when an error occurs.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

Syntax

'Declaration
Function FireError ( _
    errorCode As Integer, _
    subComponent As String, _
    description As String, _
    helpFile As String, _
    helpContext As Integer _
) As Boolean

bool FireError (
    int errorCode,
    string subComponent,
    string description,
    string helpFile,
    int helpContext
)

bool FireError (
    int errorCode, 
    String^ subComponent, 
    String^ description, 
    String^ helpFile, 
    int helpContext
)

boolean FireError (
    int errorCode, 
    String subComponent, 
    String description, 
    String helpFile, 
    int helpContext
)

function FireError (
    errorCode : int, 
    subComponent : String, 
    description : String, 
    helpFile : String, 
    helpContext : int
) : boolean

Parameters

errorCode
An Integer that identifies the error message.

subComponent
A String that contains more detail about the event source.

description
The text of the message.

helpFile
The path to the Help file that contains detailed information.

helpContext
The identifier of the topic in the Help file.

Return Value

A Boolean that indicates whether the event should continue firing or stop firing. A value of true indicates that the event should continue firing.

Remarks

Updated text:15 September 2007

Several of the events have a subComponent parameter that allows for even greater granularity in event source identification.

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

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

Change History

Release	History
15 September 2007	Changed content: Added a description of the return value.

Share via