Exec80PackageTask.InitializeTask Method

Artikkeli
12/03/2008

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

Namespace: Microsoft.SqlServer.Dts.Tasks.Exec80PackageTask
Assembly: Microsoft.SqlServer.Exec80PackageTask (in microsoft.sqlserver.exec80packagetask.dll)

Syntax

'Declaration
Public Overrides Sub InitializeTask ( _
    connections As Connections, _
    variableDispenser As VariableDispenser, _
    events As IDTSInfoEvents, _
    log As IDTSLogging, _
    eventInfos As EventInfos, _
    logEntryInfos As LogEntryInfos, _
    refTracker As ObjectReferenceTracker _
)

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

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

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

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

Parameters

connections
A Connections collection for the task.

variableDispenser
A VariableDispenser object for locking variables.

events
An object that implements the IDTSInfoEvents interface for receiving events.

log
An object that implements the IDTSLogging interface for logging events.

eventInfos
A EventInfos object.

logEntryInfos
A LogEntryInfos object.

refTracker
An ObjectReferenceTracker object.

Remarks

The run-time engine calls this method immediately after the task is created, and before validation, execution, or persistence operations. For the Exec80PackageTask and all other 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, and before validation, execution, or persistence operations.

Example

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 in which two custom events are created and added to the EventInfoscollection.

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

Thread Safety

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.

Platforms

Development Platforms

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

Target Platforms