Share via

EventsObjectWrapper.FireWarning Method

  • Article

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

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.Tasks.ScriptTask
Assembly:  Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)

Syntax

'Declaration
Public Sub FireWarning ( _
    warningCode As Integer, _
    subComponent As String, _
    description As String, _
    helpFile As String, _
    helpContext As Integer _
)
'Usage
Dim instance As EventsObjectWrapper 
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)

public void FireWarning(
    int warningCode,
    string subComponent,
    string description,
    string helpFile,
    int helpContext
)

public:
void FireWarning(
    int warningCode, 
    String^ subComponent, 
    String^ description, 
    String^ helpFile, 
    int helpContext
)

member FireWarning : 
        warningCode:int * 
        subComponent:string * 
        description:string * 
        helpFile:string * 
        helpContext:int -> unit

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

Parameters

  • warningCode
    Type: System.Int32
    Identifies the warning message.
  • subComponent
    Type: System.String
    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.

See Also

Reference

EventsObjectWrapper Class

Microsoft.SqlServer.Dts.Tasks.ScriptTask Namespace