IDTSInfoEvents.FireError Method (Int32, String, String, String, Int32)

  • Article

 

Applies To: SQL Server 2016 Preview

Fires an error.

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

Syntax

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

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

abstract FireError : 
        errorCode:int *
        subComponent:string *
        description:string *
        helpFile:string *
        helpContext:int -> bool

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

Parameters

  • errorCode
    Type: System.Int32

    An Integer that identifies the error message.

  • subComponent
    Type: System.String

    An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.

  • helpFile
    Type: System.String

    The path to the Help file that contains detailed information.

  • helpContext
    Type: System.Int32

    Identifier of the topic in the Help file.

Return Value

Type: System.Boolean

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.

See Also

IDTSInfoEvents Interface
Microsoft.SqlServer.Dts.Runtime Namespace

Return to top