• Article

IDTSComponentEvents.FireInformation Method

Raises an event containing information.

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

Syntax

'Declaration
Sub FireInformation ( _
    informationCode As Integer, _
    subComponent As String, _
    description As String, _
    helpFile As String, _
    helpContext As Integer, _
    ByRef fireAgain As Boolean _
)
'Usage
Dim instance As IDTSComponentEvents
Dim informationCode As Integer
Dim subComponent As String
Dim description As String
Dim helpFile As String
Dim helpContext As Integer
Dim fireAgain As Boolean

instance.FireInformation(informationCode, _
    subComponent, description, helpFile, _
    helpContext, fireAgain)

void FireInformation(
    int informationCode,
    string subComponent,
    string description,
    string helpFile,
    int helpContext,
    ref bool fireAgain
)

void FireInformation(
    int informationCode, 
    String^ subComponent, 
    String^ description, 
    String^ helpFile, 
    int helpContext, 
    bool% fireAgain
)

abstract FireInformation : 
        informationCode:int * 
        subComponent:string * 
        description:string * 
        helpFile:string * 
        helpContext:int * 
        fireAgain:bool byref -> unit 

function FireInformation(
    informationCode : int, 
    subComponent : String, 
    description : String, 
    helpFile : String, 
    helpContext : int, 
    fireAgain : boolean
)

Parameters

  • informationCode
    Type: System.Int32
    An Integer that identifies the informational 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.
  • fireAgain
    Type: System.Boolean%
    A Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing.

Remarks

The definition of an information event is that it is a message important enough to always be displayed to most users. It differs from a warning in that no potential damage is implied, and it differs from logging in that it cannot be turned off or filtered and in that it can be handled by event handler.

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.