IDTSComponentEvents.FireError(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 when an error occurs.
public:
bool FireError(int errorCode, System::String ^ subComponent, System::String ^ description, System::String ^ helpFile, int helpContext);
public bool FireError (int errorCode, string subComponent, string description, string helpFile, int helpContext);
abstract member FireError : int * string * string * string * int -> bool
Public Function FireError (errorCode As Integer, subComponent As String, description As String, helpFile As String, helpContext As Integer) As Boolean
Parameters
- errorCode
- Int32
An Integer that identifies the error 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.
Returns
A Boolean that indicates whether the event should continue firing or stop firing. A value of true indicates that the event should continue firing.
Remarks
Several of the events have a subComponent
parameter that allows for even greater granularity in event source identification.