DefaultEvents.OnWarning Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This event is raised anytime the task is in a state that does not justify an error, but does warrant alerting the client.
public:
virtual void OnWarning(Microsoft::SqlServer::Dts::Runtime::DtsObject ^ source, int warningCode, System::String ^ subComponent, System::String ^ description, System::String ^ helpFile, int helpContext, System::String ^ idofInterfaceWithError);
public virtual void OnWarning (Microsoft.SqlServer.Dts.Runtime.DtsObject source, int warningCode, string subComponent, string description, string helpFile, int helpContext, string idofInterfaceWithError);
abstract member OnWarning : Microsoft.SqlServer.Dts.Runtime.DtsObject * int * string * string * string * int * string -> unit
override this.OnWarning : Microsoft.SqlServer.Dts.Runtime.DtsObject * int * string * string * string * int * string -> unit
Public Overridable Sub OnWarning (source As DtsObject, warningCode As Integer, subComponent As String, description As String, helpFile As String, helpContext As Integer, idofInterfaceWithError As String)
Parameters
- source
- DtsObject
The object that caused the event.
- warningCode
- 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
- String
An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.
- description
- String
The text of the message.
- helpFile
- String
The path to the Help file that contains detailed information.
- helpContext
- Int32
Identifier of the topic in the Help file.
- idofInterfaceWithError
- String
A textual representation of the GUID of the interface that caused the error.