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 に保存されないため、コンポーネントがデザイナーに読み込まれるとき、および実行を開始するときには、このメソッドが呼び出されます。

詳細については、「Data Flow コンポーネントでのイベントの発生と定義」を参照してください。