Share via

  • Article

IDTSComponentEvents.FireWarning Method

Raises an event anytime the task is in a state that does not justify an error, but does warrant alerting the client.

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

Syntax

'Declaration
Sub FireWarning ( _
    warningCode As Integer, _
    subComponent As String, _
    description As String, _
    helpFile As String, _
    helpContext As Integer _
)
'Usage
Dim instance As IDTSComponentEvents
Dim warningCode As Integer
Dim subComponent As String
Dim description As String
Dim helpFile As String
Dim helpContext As Integer

instance.FireWarning(warningCode, subComponent, _
    description, helpFile, helpContext)

void FireWarning(
    int warningCode,
    string subComponent,
    string description,
    string helpFile,
    int helpContext
)

void FireWarning(
    int warningCode, 
    String^ subComponent, 
    String^ description, 
    String^ helpFile, 
    int helpContext
)

abstract FireWarning : 
        warningCode:int * 
        subComponent:string * 
        description:string * 
        helpFile:string * 
        helpContext:int -> unit 

function FireWarning(
    warningCode : int, 
    subComponent : String, 
    description : String, 
    helpFile : String, 
    helpContext : int
)

Parameters

  • warningCode
    Type: System.Int32
    An Integer that identifies the warning message.
  • subComponent
    Type: System.String
    A String that contains more detail about the event source.
  • helpFile
    Type: System.String
    The path to the Help file that contains detailed information.
  • helpContext
    Type: System.Int32
    The identifier of the topic in the Help file.

Remarks

Because firing of an event may be expensive, the run-time engine provides a mechanism for suppressing events that you are not interested in. Every event firing method has a FireAgain parameter. If the value of this variable is false, after the method returns, the caller will not fire this event again for the duration of the current execution.

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