IDTSComponentEvents.FireWarning Method

Article
12/03/2008

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

void FireWarning (
    int warningCode,
    string subComponent,
    string description,
    string helpFile,
    int 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
)

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

Parameters

warningCode
An Integer that identifies the warning 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.

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.

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