Export (0) Print
Expand All

Task.InitializeTask Method

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

public virtual void InitializeTask (
	Connections connections,
	VariableDispenser variableDispenser,
	IDTSInfoEvents events,
	IDTSLogging log,
	EventInfos eventInfos,
	LogEntryInfos logEntryInfos,
	ObjectReferenceTracker refTracker
)
public void InitializeTask (
	Connections connections, 
	VariableDispenser variableDispenser, 
	IDTSInfoEvents events, 
	IDTSLogging log, 
	EventInfos eventInfos, 
	LogEntryInfos logEntryInfos, 
	ObjectReferenceTracker refTracker
)
public function InitializeTask (
	connections : Connections, 
	variableDispenser : VariableDispenser, 
	events : IDTSInfoEvents, 
	log : IDTSLogging, 
	eventInfos : EventInfos, 
	logEntryInfos : LogEntryInfos, 
	refTracker : ObjectReferenceTracker
)

Parameters

connections

A collection of connections used by the task.

variableDispenser

A VariableDispenser object for locking variables.

events

An object that implements the IDTSInfoEvents interface.

log

An object that implements the IDTSLogging interface.

eventInfos

A collection that contains events to be raised during execution of the task.

logEntryInfos

A collection of log entries.

refTracker

An object reference tracker.

For stock tasks, this method is used to set the log events of each task.

The run-time engine calls InitializeTask immediately after the task is created—before validation, execution, or persistence operations.


Task developers define custom events by overriding the InitializeTask method of the Task base class, and creating a new EventInfo. The following code sample shows the InitializeTask method of a custom task, where two custom events are created, and added to the eventInfos collection.

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"];
}

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

Community Additions

ADD
Show:
© 2014 Microsoft