IDTSInfoEvents.FireError Method

Article
12/03/2008

Fires an error.

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
An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.

description
Text of the message.

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

helpContext
Identifier of the topic in the Help file.

Return Value

A Boolean that indicates if this should continue firing or stop firing. A value of true indicates that it should continue firing.

Remarks

Provides information about a failure.

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