Share via

EventsObjectWrapper.FireError Method

  • Article

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Raises an event when error occurs.

Namespace:  Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly:  Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)

Syntax

'Declaration
Public Function FireError ( _
    errorCode As Integer, _
    subComponent As String, _
    description As String, _
    helpFile As String, _
    helpContext As Integer _
) As Boolean
'Usage
Dim instance As EventsObjectWrapper 
Dim errorCode As Integer 
Dim subComponent As String 
Dim description As String 
Dim helpFile As String 
Dim helpContext As Integer 
Dim returnValue As Boolean 

returnValue = instance.FireError(errorCode, _
    subComponent, description, helpFile, _
    helpContext)

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

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

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

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

Parameters

  • errorCode
    Type: System.Int32
    Identifies the error message.
  • subComponent
    Type: System.String
    Contains more detail about the event source.
  • helpFile
    Type: System.String
    The path to Help file that contains detailed information.
  • helpContext
    Type: System.Int32
    The identifier of the topic in the Help file.

Return Value

Type: System.Boolean
True if the event should continue firing; otherwise, false.

See Also

Reference

EventsObjectWrapper Class

Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace