IDTSComponentMetaData90.FireWarning Method

Article
12/03/2008

Raises an OnWarning event.

Namespace: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly: Microsoft.SqlServer.DTSPipelineWrap (in microsoft.sqlserver.dtspipelinewrap.dll)

Syntax

'Declaration
<DispIdAttribute(127)> _
Sub FireWarning ( _
    <InAttribute> WarningCode As Integer, _
    <InAttribute> SubComponent As String, _
    <InAttribute> Description As String, _
    <InAttribute> HelpFile As String, _
    <InAttribute> HelpContext As Integer _
)

[DispIdAttribute(127)] 
void FireWarning (
    [InAttribute] int WarningCode,
    [InAttribute] string SubComponent,
    [InAttribute] string Description,
    [InAttribute] string HelpFile,
    [InAttribute] int HelpContext
)

[DispIdAttribute(127)] 
void FireWarning (
    [InAttribute] int WarningCode, 
    [InAttribute] String^ SubComponent, 
    [InAttribute] String^ Description, 
    [InAttribute] String^ HelpFile, 
    [InAttribute] int HelpContext
)

/** @attribute DispIdAttribute(127) */ 
void FireWarning (
    /** @attribute InAttribute() */ int WarningCode, 
    /** @attribute InAttribute() */ String SubComponent, 
    /** @attribute InAttribute() */ String Description, 
    /** @attribute InAttribute() */ String HelpFile, 
    /** @attribute InAttribute() */ int HelpContext
)

DispIdAttribute(127) 
function FireWarning (
    WarningCode : int, 
    SubComponent : String, 
    Description : String, 
    HelpFile : String, 
    HelpContext : int
)

Parameters

WarningCode
The component-defined error code.

SubComponent
The name of the component that raises the warning.

Description
The description of the warning.

HelpFile
The help file that contains more information about the warning.

HelpContext
The help context ID of the warning.

Remarks

An OnWarning event can be raised during package design or execution. During design time, warnings are displayed in the Task List window and cause the yellow exclamation icon to be displayed next to the component shape.

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