IDTSComponentEvents.FireInformation Method

Article
12/03/2008

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 _
)

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
)

void FireInformation (
    int informationCode, 
    String subComponent, 
    String description, 
    String helpFile, 
    int helpContext, 
    /** @ref */ boolean fireAgain
)

JScript does not support passing value-type arguments by reference.

Parameters

informationCode
An Integer that identifies the informational message.

subComponent
A String that contains more detail about the event source.

description
The text of the message.

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

helpContext
The identifier of the topic in the Help file.

fireAgain
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.

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

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via