Compartilhar via


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.

Hierarquia de herança

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

Namespace:  Microsoft.SqlServer.Dts.Tasks.ScriptTask
Assembly:  Microsoft.SqlServer.ScriptTask (em Microsoft.SqlServer.ScriptTask.dll)

Sintaxe

'Declaração
<GuidAttribute("8D1A24AD-9B5D-49E4-B160-53CD9D6ACCFD")> _
<ComVisibleAttribute(True)> _
Public Class ScriptTask _
    Inherits Task _
    Implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Uso
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

O tipo ScriptTask expõe os membros a seguir.

Construtores

  Nome Descrição
Método público ScriptTask Initializes a new instance of the ScriptTask class.

Início

Propriedades

  Nome Descrição
Propriedade pública BreakpointManager Gets the BreakpointManager used for controlling breakpoints on this task.
Propriedade pública Breakpoints Gets an array of breakpoints set on this task.
Propriedade pública 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.
Propriedade pública DefaultActiveItem Gets the default script.
Propriedade pública EntryPoint Gets or sets the name of the class that is executed as the entry point.
Propriedade pública ExecutionValue Gets a user-defined object. This field is read-only. (Substitui Task.ExecutionValue.)
Propriedade pública ProjectTemplatePath Gets the path of the specified project template.
Propriedade pública ReadOnlyVariables Gets or sets the comma-delimited list of existing variables made available to the package by the user for read-only access.
Propriedade pública ReadWriteVariables Gets or sets the comma-delimited list of existing variables made available to the package by the user for read/write access.
Propriedade pública ScriptingEngine Gets the VSTATaskScriptingEngine class.
Propriedade pública ScriptLanguage Gets or sets the programming language in which the script is written.
Propriedade pública ScriptLoaded Gets a value indicating whether the task contains custom script.
Propriedade pública ScriptProjectName Gets or sets the name of the script project.
Propriedade pública ScriptStorage Gets the [VSTAScriptProjectStorage] for the script.
Propriedade pública 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.
Propriedade pública Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Herdado de Task.)

Início

Métodos

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

Início

Comentários

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 Tarefa Script and Codificando e depurando a tarefa Script.

Exemplos

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

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Dts.Tasks.ScriptTask