ScriptTask Класс

Определение

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

Microsoft.SqlServer.Dts.Tasks.ScriptTask

Сборка:

Microsoft.SqlServer.ScriptTask.dll

Определяет классы для задачи «Скрипт», которая позволяет разработчикам писать пользовательский код для выполнения функций, недоступных во встроенных задачах, предоставляемых службами 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

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

Object

DtsObject

Task

ScriptTask

Атрибуты

DtsTaskAttribute ComVisibleAttribute GuidAttribute

Реализации

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend

Примеры

В следующем примере кода, реализованном в консольном приложении, добавляется 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 определяет задачу «Скрипт» и обрабатывает взаимодействие задачи «Скрипт» со средой выполнения и с Visual Studio для приложений.

Дополнительные сведения см. в разделе "Задача скрипта " и "Кодирование" и "Отладка задачи скрипта".

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

ScriptTask()

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

Свойства

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

Методы

AcceptBreakpointManager(BreakpointManager)	Передает объект BreakpointManager задаче. Этот метод вызывается средой выполнения и не используется в коде.
CanUpdate(String)	*** Элемент устарел; см. примечания. Логическое значение, указывающее, может ли новый XML-код пакета обновить старый XML-код пакета. (Унаследовано от Task)
Equals(Object)	Определяет, равны ли два экземпляра объекта. (Унаследовано от DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Выполняет скрипт, содержащийся в этом экземпляре задачи скрипта DTS.
Finalize()	Освобождает все ресурсы, занятые модулем ScriptTask.
GetConnectionID(Connections, String)	Возвращает строку, содержащую идентификатор соединения. (Унаследовано от Task)
GetConnectionName(Connections, String)	Возвращает строку, содержащую имя соединения. (Унаследовано от Task)
GetHashCode()	Возвращает хэш-код данного экземпляра. (Унаследовано от DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Инициализирует свойства, связанные с задачей «Скрипт». Этот метод вызывается средой выполнения и не используется в коде.
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)	Проверяет, правильно ли настроен компонент.