Udostępnij za pośrednictwem


Klasa ScriptTask

Definiuje klasy dla zadania skryptu, który umożliwia deweloperom napisać kod niestandardowy do wykonywania funkcji, które nie są dostępne w wbudowane zadania udostępnione przez Integration Services.

Hierarchia dziedziczenia

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

Przestrzeń nazw:  Microsoft.SqlServer.Dts.Tasks.ScriptTask
Zestaw:  Microsoft.SqlServer.ScriptTask (w Microsoft.SqlServer.ScriptTask.dll)

Składnia

'Deklaracja
<GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C")> _
<ComVisibleAttribute(True)> _
Public Class ScriptTask _
    Inherits Task _
    Implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Użycie
Dim instance As ScriptTask
[GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C")]
[ComVisibleAttribute(true)]
public class ScriptTask : Task, IDTSBreakpointSite, 
    IDTSSuspend, IDTSComponentPersist
[GuidAttribute(L"2EC4E475-058D-3590-8909-279F833D8B9C")]
[ComVisibleAttribute(true)]
public ref class ScriptTask : public Task, 
    IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[<GuidAttribute("2EC4E475-058D-3590-8909-279F833D8B9C")>]
[<ComVisibleAttribute(true)>]
type ScriptTask =  
    class
        inherit Task
        interface IDTSBreakpointSite
        interface IDTSSuspend
        interface IDTSComponentPersist
    end
public class ScriptTask extends Task implements IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

Typ ScriptTask uwidacznia następujące elementy członkowskie.

Konstruktorzy

  Nazwa Opis
Metoda publiczna ScriptTask Inicjuje nowe wystąpienie ScriptTask klasy

Do góry

Właściwości

  Nazwa Opis
Właściwość publiczna BreakpointManager Zwraca BreakpointManager używane do kontrolowania punktów przerwania na zadanie.
Właściwość publiczna Breakpoints Zwraca tablicę punkty przerwania zestaw nad tym zadaniem.
Właściwość publiczna DebugMode Pobiera lub ustawia wartość wskazującą, czy zadanie jest uruchomione w trybie debugowania i czy powinna podnieść OnBreakpointHit zdarzenie, gdy zadanie jest uruchomione.
Właściwość publiczna EntryPoint Pobiera lub ustawia nazwę klasy, która jest wykonywana jako punkt wejścia.
Właściwość publiczna ExecutionValue Zwraca obiekt zdefiniowany przez użytkownika.To pole jest tylko do odczytu. (Zastępuje Task.ExecutionValue).
Właściwość publiczna ReadOnlyVariables Pobiera lub ustawia listę rozdzielaną przecinkami istniejących zmiennych udostępnione do pakiet przez użytkownika dostępu tylko do odczytu.
Właściwość publiczna ReadWriteVariables Pobiera lub ustawia listę rozdzielaną przecinkami istniejących zmiennych udostępnione do pakiet przez użytkownika dla dostępu do odczytu i zapisu.
Właściwość publiczna ScriptingEngine Pobiera VSTATaskScriptingEngine klasy
Właściwość publiczna ScriptLanguage Pobiera lub ustawia język programowania, w którym napisano skrypt.
Właściwość publiczna ScriptLoaded Pobiera wartość wskazującą, czy zadania zawiera skrypt niestandardowy.
Właściwość publiczna ScriptProjectName Pobiera lub ustawia nazwę projektu skryptu.
Właściwość publiczna ScriptStorage Pobiera [VSTAScriptProjectStorage].
Właściwość publiczna SuspendRequired Pobiera lub ustawia wartość logiczna wskazuje, czy zadanie Wstrzymaj wykonywanie kodu, gdy zadanie napotka punkt przerwania.Ta wartość jest ustawiana przez uruchomienie -czas aparat zadań i pojemników po napotkaniu punktu punkt przerwania.
Właściwość publiczna Version *** Członkowskich zaniechane; Zobacz uwagi. *** Zwraca wersja zadania.Ta właściwość jest tylko do odczytu. (Dziedziczony z Task).

Do góry

Metody

  Nazwa Opis
Metoda publiczna AcceptBreakpointManager Przebiegi BreakpointManager do zadań.Ta metoda jest wywoływana w czasie wykonywania i nie jest używany w kodzie.
Metoda publiczna CanUpdate *** Członkowskich zaniechane; Zobacz uwagi. *** a wartość logiczna , wskazuje, czy nowy pakiet XML można aktualizować stare pakiet XML. (Dziedziczony z Task).
Metoda publiczna Equals Określa, czy dwa wystąpienia obiektu są równe. (Dziedziczony z DtsObject).
Metoda publiczna Execute Uruchamia zadanie skryptu. (Zastępuje Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)).
Metoda chroniona Finalize Zwalnia wszystkie zasoby używane przez ScriptTask. (Zastępuje Object.Finalize()).
Metoda publiczna GetConnectionID Pobiera ciąg zawierający identyfikator połączenia. (Dziedziczony z Task).
Metoda publiczna GetConnectionName Pobiera ciąg zawierające nazwę połączenia. (Dziedziczony z Task).
Metoda publiczna GetHashCode Zwraca kod skrótu dla tego wystąpienie. (Dziedziczony z DtsObject).
Metoda publiczna GetType (Dziedziczony z Object).
Metoda publiczna InitializeTask Inicjuje właściwości skojarzonych z zadaniem skryptu.Ta metoda jest wywoływana w czasie wykonywania i nie jest używany w kodzie. (Zastępuje Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)).
Metoda publiczna LoadFromXML Wczytuje dane zadanie skryptu z pliku XML.Ta metoda nie jest wpłacone przez kod aplikacji.Aby załadować pakiet zapisany jako XML, należy użyć Application.LoadPackage metoda.
Metoda chroniona MemberwiseClone (Dziedziczony z Object).
Metoda publiczna ReportBreakpointChanges Infrastruktura.
Metoda publiczna ResumeExecution Wznawia wykonanie zadania lub kontener przez uruchomienie -czas silnika po wstrzymaniu.
Metoda publiczna SaveToXML Zapisuje składnik zadań skryptów XML.Ta metoda nie jest wpłacone przez kod aplikacji.Aby zapisać pakiet jako XML, użyj Application.SaveToXml metoda.
Metoda publiczna SetUniqueScriptProjectName Określa unikatową nazwę projektu skryptu.
Metoda publiczna SuspendExecution Wskazuje, że plik wykonywalny musi zawiesić wykonanie.Ta metoda jest wywoływana przez uruchomienie -czas silnika.
Metoda publiczna ToString (Dziedziczony z Object).
Metoda publiczna Update *** Członkowskich zaniechane; Zobacz uwagi. *** Ta metoda aktualizuje stare pakiet XML z nowego pakietu XML, jeśli CanUpdate jest zestaw do true. (Dziedziczony z Task).
Metoda publiczna Validate Weryfikuje, że składnik jest prawidłowo skonfigurowany. (Zastępuje Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)).

Do góry

Uwagi

ScriptTask Klasy definiuje zadania skryptu i obsługi interakcji zadania skryptu z wykonawczym i Visual Studio do aplikacji.

Aby uzyskać więcej informacji, zobacz tematy Zadania skryptu i Kodowanie i zadania skryptu debugowania.

Przykłady

Poniższy przykładowy kod w aplikacji konsoli dodaje ScriptTask pakiet i wyświetla wartości domyślne niektórych właściwości.

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

Bezpieczeństwo wątków

Wszystkie publiczne statyczny (Shared w języku Visual Basic) elementy członkowskie tego typu są bezpieczne dla wątków. Nie ma gwarancji, że elementy członkowskie wystąpień będą bezpieczne dla wątków.