Classe ScriptTask

Defines the classes for the Script task, which lets developers write custom code to perform functions that are not available in the built-in tasks provided by Integration Services.

Gerarchia di ereditarietà

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTask

Spazio dei nomi  Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly:  Microsoft.SqlServer.ScriptTask (in Microsoft.SqlServer.ScriptTask.dll)

Sintassi

'Dichiarazione
<GuidAttribute("8D1A24AD-9B5D-49E4-B160-53CD9D6ACCFD")> _
<ComVisibleAttribute(True)> _
Public Class ScriptTask _
    Inherits Task _
    Implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Utilizzo
Dim instance As ScriptTask
[GuidAttribute("8D1A24AD-9B5D-49E4-B160-53CD9D6ACCFD")]
[ComVisibleAttribute(true)]
public class ScriptTask : Task, IDTSBreakpointSite, 
    IDTSSuspend, IDTSComponentPersist
[GuidAttribute(L"8D1A24AD-9B5D-49E4-B160-53CD9D6ACCFD")]
[ComVisibleAttribute(true)]
public ref class ScriptTask : public Task, 
    IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[<GuidAttribute("8D1A24AD-9B5D-49E4-B160-53CD9D6ACCFD")>]
[<ComVisibleAttribute(true)>]
type ScriptTask =  
    class 
        inherit Task 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
        interface IDTSComponentPersist 
    end
public class ScriptTask extends Task implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

Nel tipo ScriptTask sono esposti i membri seguenti.

Costruttori

  Nome Descrizione
Metodo pubblico ScriptTask Initializes a new instance of the ScriptTask class.

In alto

Proprietà

  Nome Descrizione
Proprietà pubblica BreakpointManager Gets the BreakpointManager used for controlling breakpoints on this task.
Proprietà pubblica Breakpoints Gets an array of breakpoints set on this task.
Proprietà pubblica DebugMode Gets or sets a value indicating whether the task is running in debug mode, and whether it should raise the OnBreakpointHit event while the task is running.
Proprietà pubblica DefaultActiveItem Gets the default script.
Proprietà pubblica EntryPoint Gets or sets the name of the class that is executed as the entry point.
Proprietà pubblica ExecutionValue Gets a user-defined object. This field is read-only. Esegue l'override di Task.ExecutionValue.
Proprietà pubblica ProjectTemplatePath Gets the path of the specified project template.
Proprietà pubblica ReadOnlyVariables Gets or sets the comma-delimited list of existing variables made available to the package by the user for read-only access.
Proprietà pubblica ReadWriteVariables Gets or sets the comma-delimited list of existing variables made available to the package by the user for read/write access.
Proprietà pubblica ScriptingEngine Gets the VSTATaskScriptingEngine class.
Proprietà pubblica ScriptLanguage Gets or sets the programming language in which the script is written.
Proprietà pubblica ScriptLoaded Gets a value indicating whether the task contains custom script.
Proprietà pubblica ScriptProjectName Gets or sets the name of the script project.
Proprietà pubblica ScriptStorage Gets the [VSTAScriptProjectStorage] for the script.
Proprietà pubblica SuspendRequired Gets or sets a Boolean indicating whether a task should suspend execution when the task encounters a breakpoint. This value is set by the run-time engine for tasks and containers when a breakpoint is encountered.
Proprietà pubblica Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. Ereditato da Task.

In alto

Metodi

  Nome Descrizione
Metodo pubblico AcceptBreakpointManager Passes a BreakpointManager to the task. This method is called by the runtime and is not used in code.
Metodo pubblico CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. Ereditato da Task.
Metodo pubblico Equals Determines whether two object instances are equal. Ereditato da DtsObject.
Metodo pubblico Execute Executes the script contained in this instance of DTS Script Task. Esegue l'override di Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).
Metodo protetto Finalize Releases all resources used by the ScriptTask. Esegue l'override di Object.Finalize().
Metodo pubblico GetConnectionID Gets a String containing the ID of the connection. Ereditato da Task.
Metodo pubblico GetConnectionName Gets a String containing the name of the connection. Ereditato da Task.
Metodo pubblico GetHashCode Returns the hash code for this instance. Ereditato da DtsObject.
Metodo pubblico GetType Ereditato da Object.
Metodo pubblico InitializeTask Initializes the properties associated with the Script task. This method is called by the runtime and is not used in code. Esegue l'override di Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).
Metodo pubblico LoadFromXML Implements loading of properties from XML document.
Metodo protetto MemberwiseClone Ereditato da Object.
Metodo pubblico ReportBreakpointChanges Infrastruttura. Reports the breakpoint changes from the task.
Metodo pubblico ResumeExecution Resumes execution of the task or container by the run-time engine after pausing.
Metodo pubblico SaveToXML Implements saving of properties to XML document.
Metodo pubblico SetUniqueScriptProjectName Sets the unique name of the script project.
Metodo pubblico SuspendExecution Indicates that the executable must suspend execution. This method is called by the run-time engine.
Metodo pubblico ToString Ereditato da Object.
Metodo pubblico Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. Ereditato da Task.
Metodo pubblico Validate Verifies that the component is correctly configured. Esegue l'override di Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).

In alto

Osservazioni

The ScriptTask class defines the Script task and handles the interaction of the Script task with the runtime and with Visual Studio for Applications.

For more information, see Attività Script and Scrittura di codice e debug dell'attività Script.

Esempi

The following code sample, implemented in a console application, adds a ScriptTask to the package and displays the default values of some of its properties.

using System;
using Microsoft.SqlServer.Dts.Runtime;

namespace ScriptTaskCS
{
  class Program
  {
    static void Main(string[] args)
    {
      Package pkg = new Package();
      string newLine = System.Environment.NewLine;

      Executable exe = pkg.Executables.Add("STOCK:ScriptTask");
      TaskHost thTask = (TaskHost)exe;

      string taskInfo;
      taskInfo = 
        
        "Entry point: " + 
        thTask.Properties["EntryPoint"].GetValue(thTask) + newLine + 
        "Script Language: " + 
        thTask.Properties["ScriptLanguage"].GetValue(thTask) + newLine + 
        "ReadOnlyVariables: " + 
        thTask.Properties["ReadOnlyVariables"].GetValue(thTask) + newLine + 
        "ReadWriteVariables: " + 
        thTask.Properties["ReadWriteVariables"].GetValue(thTask);

      Console.WriteLine(taskInfo);
      Console.Read();
    }
  }
}
Imports Microsoft.SqlServer.Dts.Runtime

Module Module1

  Sub Main()

    Dim pkg As New Package
    Dim newLine As String = System.Environment.NewLine

    Dim exe As Executable = pkg.Executables.Add("STOCK:ScriptTask")
    Dim thTask As TaskHost = CType(exe, TaskHost)

    Dim taskInfo As String
    taskInfo = 
      
      "Entry point: " & _
      thTask.Properties("EntryPoint").GetValue(thTask) & newLine & _
      "Script Language: " & _
      thTask.Properties("ScriptLanguage").GetValue(thTask) & newLine & _
      "ReadOnlyVariables: " & _
      thTask.Properties("ReadOnlyVariables").GetValue(thTask) & newLine & _
      "ReadWriteVariables: " & _
      thTask.Properties("ReadWriteVariables").GetValue(thTask)

    Console.WriteLine(taskInfo)
    Console.Read()

  End Sub

End Module

Protezione dei thread

I membri static (Shared in Visual Basic) pubblici di questo tipo sono affidabili. Non è invece garantita la sicurezza dei membri dell'istanza.

Vedere anche

Riferimento

Spazio dei nomi Microsoft.SqlServer.Dts.Tasks.ScriptTask