IDTSEvents.OnWarning Method
Called any time 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 OnWarning ( _
source As DtsObject, _
warningCode As Integer, _
subComponent As String, _
description As String, _
helpFile As String, _
helpContext As Integer, _
idofInterfaceWithError As String _
)
'Usage
Dim instance As IDTSEvents
Dim source As DtsObject
Dim warningCode As Integer
Dim subComponent As String
Dim description As String
Dim helpFile As String
Dim helpContext As Integer
Dim idofInterfaceWithError As String
instance.OnWarning(source, warningCode, _
subComponent, description, helpFile, _
helpContext, idofInterfaceWithError)
void OnWarning(
DtsObject source,
int warningCode,
string subComponent,
string description,
string helpFile,
int helpContext,
string idofInterfaceWithError
)
void OnWarning(
DtsObject^ source,
int warningCode,
String^ subComponent,
String^ description,
String^ helpFile,
int helpContext,
String^ idofInterfaceWithError
)
abstract OnWarning :
source:DtsObject *
warningCode:int *
subComponent:string *
description:string *
helpFile:string *
helpContext:int *
idofInterfaceWithError:string -> unit
function OnWarning(
source : DtsObject,
warningCode : int,
subComponent : String,
description : String,
helpFile : String,
helpContext : int,
idofInterfaceWithError : String
)
Parameters
- source
Type: Microsoft.SqlServer.Dts.Runtime.DtsObject
The object that caused the event.
- warningCode
Type: System.Int32
An Integer that identifies the warning message. This identifier should be unique when combined with the source parameter, so the source and warningCode combination should be unique. However, the warningCode alone is not expected to be unique.
- subComponent
Type: System.String
An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.
- description
Type: System.String
Text of the message.
- helpFile
Type: System.String
The path to the Help file that contains detailed information.
- helpContext
Type: System.Int32
Identifier of the topic in the Help file.
- idofInterfaceWithError
Type: System.String
A textual representation of the GUID of the interface that caused the error.