IDTSComponentMetaData100.FireWarning Method
Raises an OnWarning event.
Namespace: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly: Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)
Syntax
'Declaration
Sub FireWarning ( _
WarningCode As Integer, _
SubComponent As String, _
Description As String, _
HelpFile As String, _
HelpContext As Integer _
)
'Usage
Dim instance As IDTSComponentMetaData100
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(
[InAttribute] int WarningCode,
[InAttribute] String^ SubComponent,
[InAttribute] String^ Description,
[InAttribute] String^ HelpFile,
[InAttribute] 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
The component-defined error code.
- SubComponent
Type: System.String
The name of the component that raises the warning.
- Description
Type: System.String
The description of the warning.
- HelpFile
Type: System.String
The help file that contains more information about the warning.
- HelpContext
Type: System.Int32
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.