PipelineComponent.RegisterEvents Method

カスタム データ フロー コンポーネントを開発する際、このメソッドをオーバーライドしてカスタム イベントを作成します。

名前空間: Microsoft.SqlServer.Dts.Pipeline
アセンブリ: Microsoft.SqlServer.PipelineHost (microsoft.sqlserver.pipelinehost.dll 内)

構文

'宣言
Public Overridable Sub RegisterEvents

public virtual void RegisterEvents ()

public:
virtual void RegisterEvents ()

public void RegisterEvents ()

public function RegisterEvents ()

解説

このメソッドは、カスタム イベントを作成するコンポーネントによりオーバーライドされます。コンポーネントによって宣言されるカスタム イベントはパッケージ XML に保存されないため、コンポーネントがデザイナに読み込まれるとき、および実行を開始するときには、このメソッドが呼び出されます。

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

使用例

次の例は、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

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

PipelineComponent Class
PipelineComponent Members
Microsoft.SqlServer.Dts.Pipeline Namespace