ScriptTask Klasse

Referenz

Definition

Namespace:: Microsoft.SqlServer.Dts.Tasks.ScriptTask

Assembly:: Microsoft.SqlServer.ScriptTask.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Definiert die Klassen für die Skriptaufgabe, mit der Entwickler benutzerdefinierten Code schreiben können, um Funktionen auszuführen, die in den integrierten Aufgaben, die von Integration Services bereitgestellt werden, nicht verfügbar sind.

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

[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=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("04FAEAC9-FB98-4F21-8F96-0E857B739740")]
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=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("4DF420FB-D5C2-4357-8FBE-ECB5E15554F8")]
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")]
public class ScriptTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist

[<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=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Runtime.InteropServices.Guid("04FAEAC9-FB98-4F21-8F96-0E857B739740")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface 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=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("4DF420FB-D5C2-4357-8FBE-ECB5E15554F8")>]
type ScriptTask = class
    inherit Task
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface 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, das in einer Konsolenanwendung implementiert ist, fügt dem Paket ein und ScriptTask zeigt die Standardwerte einiger 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 ScriptTask Klasse definiert die Skriptaufgabe und behandelt die Interaktion der Skriptaufgabe mit der Laufzeit und mit Visual Studio für Applikationen.

Weitere Informationen finden Sie unter Skriptaufgabe und Codeerstellung und Debuggen der Skriptaufgabe.

Konstruktoren

ScriptTask()

Initialisiert eine neue Instanz der ScriptTask-Klasse.

Eigenschaften

BreakpointManager	Ruft den BreakpointManager ab, der zum Steuern von Breakpoints in diesem Task verwendet wird.
Breakpoints	Ruft ein Array von Breakpoints ab, die für diesen Task festgelegt wurden.
DebugMode	Ruft einen Wert ab, der angibt, ob der Task im Debugmodus ausgeführt wird und bei der Ausführung das OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget)-Ereignis auslösen soll, oder legt ihn fest.
DefaultActiveItem	Ruft das Standardskript ab.
EntryPoint	Ruft den Namen der Klasse ab, die als Einstiegspunkt ausgeführt wird, oder legt ihn fest.
ExecutionValue	Ruft ein benutzerdefiniertes Objekt ab. Dieses Feld ist schreibgeschützt.
ProjectTemplatePath	Ruft den Pfad der angegebenen Projektvorlage ab.
ReadOnlyVariables	Ruft die durch Trennzeichen getrennte Liste vorhandener Variablen ab, die der Benutzer dem Paket für den schreibgeschützten Zugriff zur Verfügung gestellt hat, oder legt sie fest.
ReadWriteVariables	Ruft die durch Trennzeichen getrennte Liste vorhandener Variablen ab, die der Benutzer dem Paket für den Lese-/Schreibzugriff zur Verfügung gestellt hat, oder legt sie fest.
ScriptingEngine	Ruft die VSTATaskScriptingEngine-Klasse ab.
ScriptLanguage	Ruft die Programmiersprache ab, in der das Skript geschrieben ist, oder legt sie fest.
ScriptLoaded	Ruft einen Wert ab, der angibt, ob der Task ein benutzerdefiniertes Skript enthält.
ScriptProjectName	Ruft den Namen des Skriptprojekts ab oder legt ihn fest.
ScriptStorage	Ruft die VSTAScriptProjectStorage für das Skript ab
SuspendRequired	Dient zum Abrufen oder Festlegen eines booleschen Werts, der angibt, ob eine Aufgabe die Ausführung angehalten werden soll, wenn der Vorgang auf einen Haltepunkt trifft. Dieser Wert wird von der Runtime-Engine für Tasks und Container festgelegt, wenn ein Breakpoint erreicht wird.
TargetServerVersion	Definiert die Klassen für die Skriptaufgabe, mit der Entwickler benutzerdefinierten Code schreiben können, um Funktionen auszuführen, die in den integrierten Aufgaben, die von Integration Services bereitgestellt werden, nicht verfügbar sind. (Geerbt von Task)
Version	Mitglied veraltet; siehe Hinweise. *** Gibt die Version des Tasks zurück. Diese Eigenschaft ist schreibgeschützt. (Geerbt von Task)

Methoden

AcceptBreakpointManager(BreakpointManager)	Übergibt BreakpointManager an den Task. Diese Methode wird von der Laufzeit aufgerufen und wird nicht in Code verwendet.
CanUpdate(String)	Mitglied veraltet; siehe Hinweise. Ein boolescher Wert, der angibt, ob der neue Paket-XML-Code das alte Paket-XML aktualisieren kann. (Geerbt von Task)
Equals(Object)	Stellt fest, ob zwei Objektinstanzen gleich sind. (Geerbt von DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Führt das in dieser Instanz des DTS-Skripttasks enthaltene Skript aus.
Finalize()	Gibt alle vom ScriptTask verwendeten Ressourcen frei.
GetConnectionID(Connections, String)	Ruft eine Zeichenfolge ab, die die ID der Verbindung enthält. (Geerbt von Task)
GetConnectionName(Connections, String)	Ruft eine Zeichenfolge ab, die den Namen der Verbindung enthält. (Geerbt von Task)
GetHashCode()	Gibt den Hashcode für diese Instanz zurück. (Geerbt von DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Initialisiert die dem Skripttask zugeordneten Eigenschaften. Diese Methode wird von der Laufzeit aufgerufen und wird nicht in Code verwendet.
LoadFromXML(XmlElement, IDTSInfoEvents)	Implementiert das Laden von Eigenschaften aus einem XML-Dokument.
ReportBreakpointChanges()	Meldet die Breakpointänderungen aus dem Task.
ResumeExecution()	Die Runtime-Engine setzt die Ausführung des Tasks oder Containers nach einer Unterbrechung fort.
SaveToXML(XmlDocument, IDTSInfoEvents)	Implementiert das Speichern von Eigenschaften in einem XML-Dokument.
SetUniqueScriptProjectName()	Legt den eindeutigen Namen des Skriptprojekts fest.
SuspendExecution()	Gibt an, dass die Ausführung des ausführbaren Elements angehalten werden muss. Diese Methode wird von der Runtime-Engine aufgerufen.
Update(String)	Mitglied veraltet; siehe Hinweise. Diese Methode aktualisiert den alten Paket-XML-Code mit dem neuen Paket-XML, wenn CanUpdate(String) er auf "true" festgelegt ist. (Geerbt von Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Überprüft, ob die Komponente ordnungsgemäß konfiguriert ist.

Gilt für: