IDTSComponentEvents.FireCustomEvent 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.
Occurs when tasks raise custom task-defined events.
public:
void FireCustomEvent(System::String ^ eventName, System::String ^ eventText, cli::array <System::Object ^> ^ % arguments, System::String ^ subComponent, bool % fireAgain);public void FireCustomEvent (string eventName, string eventText, ref object[] arguments, string subComponent, ref bool fireAgain);abstract member FireCustomEvent : string * string * Object[] * string * bool -> unitPublic Sub FireCustomEvent (eventName As String, eventText As String, ByRef arguments As Object(), subComponent As String, ByRef fireAgain As Boolean)Parameters
- eventName
- String
The name of the event to raise.
- eventText
- String
The text describing the event.
- arguments
- Object[]
An array of arguments to pass to the event.
- subComponent
- String
A String that contains more detail about the event source.
- fireAgain
- Boolean
A Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing.
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, then 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.