ScriptTask Klasse

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.ScriptTask

Assembly:

Microsoft.SqlServer.ScriptTask.dll

Definiert die Klassen für die Script-Aufgabe, die es Entwicklern ermöglicht, benutzerdefinierten Code zu schreiben, um Funktionen auszuführen, die in den integrierten Aufgaben von Integration Services nicht verfügbar sind.

public ref class ScriptTask : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist

[System.Runtime.InteropServices.ComVisible(true)]
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("C2F3965A-3FE3-482B-A6F3-2514B78E149D")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist

[<System.Runtime.InteropServices.ComVisible(true)>]
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.scripttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.ScriptTask.Localized), SamplesTag="SsisScriptTask", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.ScriptTask.ScriptTaskUI, Microsoft.SqlServer.ScriptTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("C2F3965A-3FE3-482B-A6F3-2514B78E149D")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

Public Class ScriptTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist

Vererbung

Object

DtsObject

Task

ScriptTask

Attribute

DtsTaskAttribute ComVisibleAttribute GuidAttribute

Implementiert

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend

Beispiele

Das folgende Codebeispiel, implementiert in einer Konsolenanwendung, fügt dem Paket ein A ScriptTask hinzu und zeigt die Standardwerte einiger seiner Eigenschaften an.

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  

Hinweise

Die Klasse ScriptTask definiert die Script-Aufgabe und übernimmt die Interaktion der Script-Aufgabe mit der Laufzeit und mit Visual Studio for Applications.

Weitere Informationen finden Sie unter Script-Aufgabe und Codierung und Debugging der Script-Aufgabe.

Konstruktoren

Name	Beschreibung
ScriptTask()	Initialisiert eine neue Instanz der ScriptTask-Klasse.

Eigenschaften

Name	Beschreibung
BreakpointManager	Das wird verwendet, BreakpointManager um Breakpoints bei dieser Aufgabe zu steuern.
Breakpoints	Erhält ein Array von Breakpoints auf dieser Aufgabe.
DebugMode	Erhält oder setzt einen Wert, der angibt, ob die Aufgabe im Debug-Modus läuft und ob das OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) Ereignis ausgelöst werden soll, während die Aufgabe läuft.
DefaultActiveItem	Es bekommt das Standardskript.
EntryPoint	Erhält oder setzt den Namen der ausgeführten Klasse als Eintrittspunkt.
ExecutionValue	Erhält ein benutzerdefiniertes Objekt. Dieses Feld ist schreibgeschützt.
ProjectTemplatePath	Erhält den Pfad der angegebenen Projektvorlage.
ReadOnlyVariables	Erhält oder setzt die komma-getrennte Liste der vorhandenen Variablen, die vom Benutzer dem Paket für den Schreibzugriff bereitgestellt werden.
ReadWriteVariables	Erhält oder setzt die komma-getrennte Liste der vorhandenen Variablen, die dem Benutzer dem Paket für Lese-/Schreibzugriff zur Verfügung gestellt werden.
ScriptingEngine	Ruft die VSTATaskScriptingEngine Klasse ab.
ScriptLanguage	Erhält oder setzt die Programmiersprache, in der das Skript geschrieben ist.
ScriptLoaded	Erhält einen Wert, der angibt, ob die Aufgabe ein benutzerdefiniertes Skript enthält.
ScriptProjectName	Bekommt oder setzt den Namen des Skriptprojekts.
ScriptStorage	Erhält das VSTAScriptProjectStorage für das Skript.
SuspendRequired	Erhält oder setzt einen Boolean, der angibt, ob eine Aufgabe die Ausführung aussetzen soll, wenn sie auf einen Breakpoint trifft. Dieser Wert wird von der Laufzeit-Engine für Aufgaben und Container festgelegt, wenn ein Breakpoint erreicht wird.
TargetServerVersion	Definiert die Klassen für die Script-Aufgabe, die es Entwicklern ermöglicht, benutzerdefinierten Code zu schreiben, um Funktionen auszuführen, die in den integrierten Aufgaben von Integration Services nicht verfügbar sind. (Geerbt von Task)
Version	Mitglied veraltet; siehe Bemerkungen. Gibt die Version der Aufgabe zurück. Diese Eigenschaft ist schreibgeschützt. (Geerbt von Task)

Methoden

Name	Beschreibung
AcceptBreakpointManager(BreakpointManager)	Gibt ein A BreakpointManager an die Aufgabe weiter. Diese Methode wird von der Laufzeit aufgerufen und im Code nicht verwendet.
CanUpdate(String)	Mitglied veraltet; siehe Bemerkungen. Ein Boolesche Bereich, der angibt, ob das neue Paket-XML das alte Paket-XML aktualisieren kann. (Geerbt von Task)
Equals(Object)	Bestimmt, ob zwei Objektinstanzen gleich sind. (Geerbt von DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Führt das Skript aus, das in dieser Instanz der DTS Script Task enthalten ist.
Finalize()	Gibt alle vom ScriptTaskverwendeten Ressourcen frei.
GetConnectionID(Connections, String)	Erhält einen String, der die ID der Verbindung enthält. (Geerbt von Task)
GetConnectionName(Connections, String)	Erhält eine Zeichenkette, die den Namen der Verbindung enthält. (Geerbt von Task)
GetHashCode()	Gibt den Hashcode für diesen instance zurück. (Geerbt von DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Initialisiert die mit der Skript-Aufgabe verbundenen Eigenschaften. Diese Methode wird von der Laufzeit aufgerufen und im Code nicht verwendet.
LoadFromXML(XmlElement, IDTSInfoEvents)	Implementiert das Laden von Eigenschaften aus einem XML-Dokument.
ReportBreakpointChanges()	Meldet die Änderungen an den Breakpoints durch die Aufgabe.
ResumeExecution()	Setzt die Ausführung der Aufgabe oder des Containers durch die Laufzeit-Engine nach dem Pausieren wieder auf.
SaveToXML(XmlDocument, IDTSInfoEvents)	Implementiert das Speichern von Eigenschaften im XML-Dokument.
SetUniqueScriptProjectName()	Legt den einzigartigen Namen des Skriptprojekts fest.
SuspendExecution()	Gibt an, dass die ausführbare Datei die Ausführung aussetzen muss. Diese Methode wird von der Laufzeit-Engine aufgerufen.
Update(String)	Mitglied veraltet; siehe Bemerkungen. Diese Methode aktualisiert das alte Paket XML mit dem neuen Paket XML, wenn CanUpdate(String) auf true gesetzt ist. (Geerbt von Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Überprüft, dass die Komponente korrekt konfiguriert ist.