EventInfos.Add メソッド
現在の EventInfos コレクションに EventInfo オブジェクトを追加します。
名前空間: Microsoft.SqlServer.Dts.Runtime
アセンブリ: Microsoft.SqlServer.ManagedDTS (Microsoft.SqlServer.ManagedDTS.dll)
構文
'宣言
Public Sub Add ( _
eventName As String, _
description As String, _
allowEventHandlers As Boolean, _
parameterNames As String(), _
parameterTypes As TypeCode(), _
parameterDescriptions As String() _
)
'使用
Dim instance As EventInfos
Dim eventName As String
Dim description As String
Dim allowEventHandlers As Boolean
Dim parameterNames As String()
Dim parameterTypes As TypeCode()
Dim parameterDescriptions As String()
instance.Add(eventName, description, allowEventHandlers, _
parameterNames, parameterTypes, _
parameterDescriptions)
public void Add(
string eventName,
string description,
bool allowEventHandlers,
string[] parameterNames,
TypeCode[] parameterTypes,
string[] parameterDescriptions
)
public:
void Add(
String^ eventName,
String^ description,
bool allowEventHandlers,
array<String^>^ parameterNames,
array<TypeCode>^ parameterTypes,
array<String^>^ parameterDescriptions
)
member Add :
eventName:string *
description:string *
allowEventHandlers:bool *
parameterNames:string[] *
parameterTypes:TypeCode[] *
parameterDescriptions:string[] -> unit
public function Add(
eventName : String,
description : String,
allowEventHandlers : boolean,
parameterNames : String[],
parameterTypes : TypeCode[],
parameterDescriptions : String[]
)
パラメーター
- eventName
型: System.String
カスタム イベントの名前です。
- description
型: System.String
イベントの説明を表す String です。
- allowEventHandlers
型: System.Boolean
開発ツールを使用してイベントにイベント ハンドラー オブジェクトを作成できるかどうかを示す Boolean です。 true の場合は、イベントに対してイベント ハンドラー オブジェクトを作成できます。
- parameterNames
型: array<System.String[]
イベントに渡すパラメーターの配列です。
- parameterTypes
型: array<System.TypeCode[]
parameterNames 配列中の各パラメーターの型です。
- parameterDescriptions
型: array<System.String[]
parameterNames 中の各パラメーターの説明を表す配列です。
説明
EventInfos コレクションと Add メソッドの例については、「カスタム タスクの開発」を参照してください。
使用例
次の例では、カスタム イベントが EventInfos コレクションに追加されます。
public override void InitializeTask(Connections connections, VariableDispenser variables, IDTSInfoEvents events, IDTSLogging log, EventInfos eventInfos, LogEntryInfos logEntryInfos, ObjectReferenceTracker refTracker)
{
this.eventInfos = eventInfos;
string[] paramNames = new string[1];
TypeCode[] paramTypes = new TypeCode[1]{TypeCode.Int32};
string[] paramDescriptions = new string[1];
paramNames[0] = "InitialValue";
paramDescriptions[0] = "The value before increment.";
this.eventInfos.Add("OnBeforeIncrement","Fires before the task increments the value.",true,paramNames,paramTypes,paramDescriptions);
this.onBeforeIncrement = this.eventInfos["OnBeforeIncrement"];
paramDescriptions[0] = "The value after increment.";
this.eventInfos.Add("OnAfterIncrement","Fires after the initial value is updated.",true,paramNames, paramTypes,paramDescriptions);
this.onAfterIncrement = this.eventInfos["OnAfterIncrement"];
}
Public Overrides Sub InitializeTask(ByVal connections As Connections, ByVal variables As VariableDispenser, ByVal events As IDTSInfoEvents, ByVal log As IDTSLogging, ByVal eventInfos As EventInfos, ByVal logEntryInfos As LogEntryInfos, ByVal refTracker As ObjectReferenceTracker)
Me.eventInfos = eventInfos
Dim paramNames(0) As String
Dim paramTypes(0) As TypeCode = {TypeCode.Int32}
Dim paramDescriptions(0) As String
paramNames(0) = "InitialValue"
paramDescriptions(0) = "The value before increment."
Me.eventInfos.Add("OnBeforeIncrement", "Fires before the task increments the value.", True, paramNames, paramTypes, paramDescriptions)
Me.onBeforeIncrement = Me.eventInfos("OnBeforeIncrement")
paramDescriptions(0) = "The value after increment."
Me.eventInfos.Add("OnAfterIncrement", "Fires after the initial value is updated.", True, paramNames, paramTypes, paramDescriptions)
Me.onAfterIncrement = Me.eventInfos("OnAfterIncrement")
End Sub