ScriptTask Classe

Definizione

Spazio dei nomi:

Microsoft.SqlServer.Dts.Tasks.ScriptTask

Assembly:

Microsoft.SqlServer.ScriptTask.dll

Definisce le classi per l'attività Script, che consente agli sviluppatori di scrivere codice personalizzato per eseguire funzioni non disponibili nelle attività predefinite fornite da Integration Services.

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

Ereditarietà

Object

DtsObject

Task

ScriptTask

Attributi

DtsTaskAttribute ComVisibleAttribute GuidAttribute

Implementazioni

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend

Esempio

Nell'esempio di codice seguente, implementato in un'applicazione console, viene aggiunto un ScriptTask oggetto al pacchetto e vengono visualizzati i valori predefiniti di alcune delle relative proprietà.

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  

Commenti

La ScriptTask classe definisce l'attività Script e gestisce l'interazione dell'attività Script con il runtime e con Visual Studio for Applications.

Per altre informazioni, vedere Attività Script e Codifica e debug dell'attività Script.

Costruttori

ScriptTask()

Inizializza una nuova istanza della classe ScriptTask.

Proprietà

BreakpointManager	Ottiene l'oggetto BreakpointManager utilizzato per il controllo dei punti di interruzione in questa attività.
Breakpoints	Ottiene una matrice di punti di interruzione impostati su questa attività.
DebugMode	Ottiene o imposta un valore che indica se l'attività è in esecuzione in modalità di debug e se deve essere generato l'evento OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) durante l'esecuzione dell'attività.
DefaultActiveItem	Ottiene lo script predefinito.
EntryPoint	Ottiene o imposta il nome della classe eseguita come punto di ingresso.
ExecutionValue	Ottiene un oggetto definito dall'utente. Questo campo è di sola lettura.
ProjectTemplatePath	Ottiene il percorso del modello di progetto specificato.
ReadOnlyVariables	Ottiene o imposta l'elenco delimitato da virgole delle variabili esistenti rese disponibili per il pacchetto dall'utente per l'accesso in sola lettura.
ReadWriteVariables	Ottiene o imposta l'elenco delimitato da virgole delle variabili esistenti rese disponibili per il pacchetto dall'utente per l'accesso in lettura/scrittura.
ScriptingEngine	Ottiene la classe VSTATaskScriptingEngine.
ScriptLanguage	Ottiene o imposta il linguaggio di programmazione utilizzato per la scrittura dello script.
ScriptLoaded	Ottiene un valore che indica se l'attività contiene uno script personalizzato.
ScriptProjectName	Ottiene o imposta il nome del progetto script.
ScriptStorage	Ottiene VSTAScriptProjectStorage per lo script.
SuspendRequired	Ottiene o imposta un valore Boolean che indica se un'attività deve sospendere l'esecuzione quando l'attività rileva un punto di interruzione. Questo valore viene impostato dal motore di runtime per le attività e i contenitori quando viene rilevato un punto di interruzione.
TargetServerVersion	Definisce le classi per l'attività Script, che consente agli sviluppatori di scrivere codice personalizzato per eseguire funzioni non disponibili nelle attività predefinite fornite da Integration Services. (Ereditato da Task)
Version	*** Membro deprecato; vedere la sezione Osservazioni. Restituisce la versione dell'attività. Questa proprietà è di sola lettura. (Ereditato da Task)

Metodi

AcceptBreakpointManager(BreakpointManager)	Passa un oggetto BreakpointManager all'attività. Questo metodo viene chiamato dal runtime e non è utilizzato nel codice.
CanUpdate(String)	*** Membro deprecato; vedere la sezione Osservazioni. Valore booleano che indica se il nuovo xml del pacchetto può aggiornare il codice XML del pacchetto precedente. (Ereditato da Task)
Equals(Object)	Determina se due istanze di un oggetto sono uguali. (Ereditato da DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Esegue lo script contenuto in questa istanza dell'attività Script DTS.
Finalize()	Rilascia tutte le risorse usate da ScriptTask.
GetConnectionID(Connections, String)	Ottiene una stringa contenente l'ID della connessione. (Ereditato da Task)
GetConnectionName(Connections, String)	Ottiene una stringa contenente il nome della connessione. (Ereditato da Task)
GetHashCode()	Restituisce il codice hash per l'istanza. (Ereditato da DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Inizializza le proprietà associate all'attività Script. Questo metodo viene chiamato dal runtime e non è utilizzato nel codice.
LoadFromXML(XmlElement, IDTSInfoEvents)	Implementa il caricamento di proprietà da un documento XML.
ReportBreakpointChanges()	Indica le modifiche del punto di interruzione rispetto all'attività.
ResumeExecution()	Riprende l'esecuzione dell'attività o del contenitore mediante il motore di runtime dopo la sospensione.
SaveToXML(XmlDocument, IDTSInfoEvents)	Implementa il salvataggio di proprietà in un documento XML.
SetUniqueScriptProjectName()	Imposta il nome univoco del progetto script.
SuspendExecution()	Indica la necessità di sospendere l'esecuzione dell'eseguibile. Questo metodo viene chiamato dal motore di runtime.
Update(String)	*** Membro deprecato; vedere la sezione Osservazioni. Questo metodo aggiorna il codice XML del pacchetto precedente con il nuovo codice XML del pacchetto se CanUpdate(String) è impostato su true. (Ereditato da Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Verifica che il componente sia configurato correttamente.