PipelineComponent.RegisterEvents 方法

定义

命名空间:

Microsoft.SqlServer.Dts.Pipeline

程序集:

Microsoft.SqlServer.PipelineHost.dll

当您正在开发一个自定义数据流组件时，您重写此方法以创建自定义事件。

public:
 virtual void RegisterEvents();

public virtual void RegisterEvents ();

abstract member RegisterEvents : unit -> unit
override this.RegisterEvents : unit -> unit

Public Overridable Sub RegisterEvents ()

示例

以下示例演示重写此方法并使用集合创建自定义事件的 EventInfos 组件。

public override void RegisterEvents()  
{  
string[] parameters = new string[1]{"Parameter1"};  
ushort[] types = new ushort[1]{DtsConvert.VarTypeFromTypeCode(TypeCode.String)};  
string[] descriptions = new string [1]{"The first parameter."};  

EventInfos.Add("OnPreExecute", "Fires when the PreExecute method runs.", false, ref parameters, ref types, ref descriptions);  

}  

Public Overrides Sub RegisterEvents()   
 Dim parameters As String() = New String(1) {"Parameter1"}   
 Dim types As System.UInt16() = New System.UInt16(1) {DtsConvert.VarTypeFromTypeCode(TypeCode.String)}   
 Dim descriptions As String() = New String(1) {"The first parameter."}   
 EventInfos.Add("OnPreExecute", "Fires when the PreExecute method runs.", False, parameters, types, descriptions)   
End Sub  

注解

此方法由创建自定义事件的组件重写。 由于组件声明的自定义事件不会保留在包 XML 中，因此在组件加载到设计器中并在执行开始时调用此方法。

有关详细信息，请参阅数据流组件中的引发和定义事件。