IDTSComponentEvents.FireWarning(Int32, String, String, String, Int32) 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.
Raises an event anytime the task is in a state that does not justify an error, but does warrant alerting the client.
public:
void FireWarning(int warningCode, System::String ^ subComponent, System::String ^ description, System::String ^ helpFile, int helpContext);public void FireWarning (int warningCode, string subComponent, string description, string helpFile, int helpContext);abstract member FireWarning : int * string * string * string * int -> unitPublic Sub FireWarning (warningCode As Integer, subComponent As String, description As String, helpFile As String, helpContext As Integer)Parameters
- warningCode
- Int32
An Integer that identifies the warning message.
- subComponent
- String
A String that contains more detail about the event source.
- description
- String
The text of the message.
- helpFile
- String
The path to the Help file that contains detailed information.
- helpContext
- Int32
The identifier of the topic in the Help file.
Remarks
Because firing of an event may be expensive, the run-time engine provides a mechanism for suppressing events that you are not interested in. Every event firing method has a FireAgain parameter. If the value of this variable is false, after the method returns, the caller will not fire this event again for the duration of the current execution.
Several of the events have a subComponent parameter that allows for even greater granularity in event source identification.