ScriptTask Класс

Определение

Пространство имен:

Microsoft.SqlServer.Dts.Tasks.ScriptTask

Сборка:

Microsoft.SqlServer.ScriptTask.dll

Определяет классы для задачи Script, которая позволяет разработчикам писать пользовательский код для выполнения функций, недоступных в встроенных задачах, предоставляемых сервисами интеграции.

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

Наследование

Object

DtsObject

Task

ScriptTask

Атрибуты

DtsTaskAttribute ComVisibleAttribute GuidAttribute

Реализации

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend

Примеры

Следующий пример кода, реализованный в консольном приложении, добавляет a ScriptTask в пакет и отображает значения по умолчанию некоторых его свойств.

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  

Комментарии

ScriptTask Класс определяет задачу Script и обрабатывает взаимодействие задачи Script с временем выполнения и с Visual Studio for Applications.

Для получения дополнительной информации смотрите раздел Script Task and Coding and Debugging the Script Task.

Конструкторы

Имя	Описание
ScriptTask()	Инициализирует новый экземпляр класса ScriptTask.

Свойства

Имя	Описание
BreakpointManager	Получает возможность BreakpointManager контролировать точки тормоза в этой задаче.
Breakpoints	Получает массив точек остановки для этой задачи.
DebugMode	Получает или устанавливает значение, указывающее, выполняется ли задача в режиме отладки и следует ли вызвать OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) событие во время выполнения задачи.
DefaultActiveItem	Получает стандартный скрипт.
EntryPoint	Получает или устанавливает имя класса, который выполняется, в качестве входной точки.
ExecutionValue	Получает объект, определённый пользовательством. Это поле доступно только для чтения.
ProjectTemplatePath	Получает путь указанного шаблона проекта.
ReadOnlyVariables	Получает или устанавливает список существующих переменных, выделенных по запятой, доступных пакету пользователем для доступа только для чтения.
ReadWriteVariables	Получает или устанавливает список существующих переменных, доступных пакету пользователем для чтения/записи.
ScriptingEngine	VSTATaskScriptingEngine Возвращает класс.
ScriptLanguage	Получает или устанавливает язык программирования, на котором написан скрипт.
ScriptLoaded	Получает значение, указывающее, содержит ли задача пользовательский скрипт.
ScriptProjectName	Получает или устанавливает название скрипт-проекта.
ScriptStorage	Получает VSTAScriptProjectStorage для скрипта.
SuspendRequired	Получает или устанавливает булевое значение, указывающее, следует ли задаче приостанавливать выполнение при столкновении с точкой остановки. Это значение задаётся движком выполнения для задач и контейнеров при обнаружении точки остановки.
TargetServerVersion	Определяет классы для задачи Script, которая позволяет разработчикам писать пользовательский код для выполнения функций, недоступных в встроенных задачах, предоставляемых сервисами интеграции. (Унаследовано от Task)
Version	Член уходил из употребления; см. Примечания. Возвращает версию задачи. Это свойство доступно только для чтения. (Унаследовано от Task)

Методы

Имя	Описание
AcceptBreakpointManager(BreakpointManager)	Переходит BreakpointManager к задаче. Этот метод вызывается в среде выполнения и не используется в коде.
CanUpdate(String)	Член уходил из употребления; см. Примечания. Булевое значение, указывающее, может ли новый XML пакета обновлять старый XML пакета. (Унаследовано от Task)
Equals(Object)	Определяет, равны ли два экземпляра объекта. (Унаследовано от DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Выполняет скрипт, содержащийся в этом экземпляре DTS Script Task.
Finalize()	Освобождает все ресурсы, используемые параметром ScriptTask.
GetConnectionID(Connections, String)	Получает строку с идентификатором соединения. (Унаследовано от Task)
GetConnectionName(Connections, String)	Получает строку с названием соединения. (Унаследовано от Task)
GetHashCode()	Возвращает хэш-код для этого экземпляра. (Унаследовано от DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Инициализирует свойства, связанные с задачей Script. Этот метод вызывается в среде выполнения и не используется в коде.
LoadFromXML(XmlElement, IDTSInfoEvents)	Реализует загрузку свойств из XML-документа.
ReportBreakpointChanges()	Сообщает об изменениях точки остановки по сравнению с задачей.
ResumeExecution()	Возобновляет выполнение задачи или контейнера движком выполнения после паузы.
SaveToXML(XmlDocument, IDTSInfoEvents)	Реализует сохранение свойств в XML-документе.
SetUniqueScriptProjectName()	Устанавливает уникальное название скрипт-проекта.
SuspendExecution()	Указывает, что исполняемый файл должен приостановить выполнение. Этот метод называется движком времени выполнения.
Update(String)	Член уходил из употребления; см. Примечания. Этот метод обновляет XML старого пакета с новым XML пакета, если CanUpdate(String) установлен true. (Унаследовано от Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Проверяет, правильно ли настроен компонент.