IDTSComponentMetaData100.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.
Raises a custom event defined by a component.
public:
void FireCustomEvent(System::String ^ EventName, System::String ^ EventText, cli::array <System::Object ^> ^ % ppsaArguments, System::String ^ SubComponent, [Runtime::InteropServices::Out] bool % pbFireAgain);[System.Runtime.InteropServices.DispId(130)]
public void FireCustomEvent (string EventName, string EventText, ref object[] ppsaArguments, string SubComponent, out bool pbFireAgain);[<System.Runtime.InteropServices.DispId(130)>]
abstract member FireCustomEvent : string * string * Object[] * string * bool -> unitPublic Sub FireCustomEvent (EventName As String, EventText As String, ByRef ppsaArguments As Object(), SubComponent As String, ByRef pbFireAgain As Boolean)Parameters
- EventName
- String
The name of the custom event.
- EventText
- String
The text that describes the event.
- ppsaArguments
- Object[]
The array of arguments that match the arguments defined when the custom event is defined.
- SubComponent
- String
The name of the component that raises the custom event.
- pbFireAgain
- Boolean
Specifies whether the event should be raised again in the future.
- Attributes
Remarks
The FireCustomEvent method is used to raise a custom event that is defined by the component. The EventName and ppsaArguments parameters must match the name and parameter definitions of the custom event as they were defined when created by the component during the RegisterEvents method.