TaskHost Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет контейнер, который инкапсулирует одну задачу. В конструкторе служб SSIS TaskHost не настраивается отдельно; он настраивается при определении свойств содержащейся в нем задачи.
public ref class TaskHost sealed : Microsoft::SqlServer::Dts::Runtime::EventsProvider, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSObjectHost, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProviderEx
public sealed class TaskHost : Microsoft.SqlServer.Dts.Runtime.EventsProvider, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSObjectHost, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProviderEx
type TaskHost = class
inherit EventsProvider
interface IDTSObjectHost
interface IDTSPropertiesProvider
interface IDTSPropertiesProviderEx
interface IDTSPackagePath
interface IDTSExecutionPath
Public NotInheritable Class TaskHost
Inherits EventsProvider
Implements IDTSExecutionPath, IDTSObjectHost, IDTSPackagePath, IDTSPropertiesProvider, IDTSPropertiesProviderEx
- Наследование
- Реализации
Примеры
В следующем примере кода показано создание пустого пакета. Две задачи добавляются в пакет и приведения в TaskHost класс, поэтому TaskHost методы и свойства можно использовать для любой задачи, например InnerObject метода, независимо от типа задачи.
using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.BulkInsertTask;
using Microsoft.SqlServer.Dts.Tasks.FileSystemTask;
namespace Microsoft.SqlServer.SSIS.Samples
{
class Program
{
static void Main(string[] args)
{
Package p = new Package();
// Add a File System task to the package.
Executable exec1 = p.Executables.Add("STOCK:FileSystemTask");
TaskHost thFileSystemTask = exec1 as TaskHost;
// Add a Bulk Insert task to the package.
Executable exec2 = p.Executables.Add("STOCK:BulkInsertTask");
TaskHost thBulkInsertTask = exec2 as TaskHost;
// Iterate through the package Executables collection.
Executables pExecs = p.Executables;
foreach (Executable pExec in pExecs)
{
TaskHost taskHost = (TaskHost)pExec;
Console.WriteLine("Type {0}", taskHost.InnerObject.ToString());
}
}
}
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.BulkInsertTask
Imports Microsoft.SqlServer.Dts.Tasks.FileSystemTask
Namespace Microsoft.SqlServer.SSIS.Samples
Class Program
Shared Sub Main(ByVal args() As String)
Dim p As Package = New Package()
' Add a File System task to the package.
Dim exec1 As Executable = p.Executables.Add("STOCK:FileSystemTask")
Dim thFileSystemTask As TaskHost = exec1 as TaskHost
' Add a Bulk Insert task to the package.
Dim exec2 As Executable = p.Executables.Add("STOCK:BulkInsertTask")
Dim thBulkInsertTask As TaskHost = exec2 as TaskHost
' Iterate through the package Executables collection.
Dim pExecs As Executables = p.Executables
Dim pExec As Executable
For Each pExec In pExecs
Dim taskHost As TaskHost = CType(pExec, TaskHost)
Console.WriteLine("Type {0}", taskHost.InnerObject.ToString())
Next
End Sub
End Class
End Namespace
Образец вывода:
Тип Microsoft.SqlServer.Dts.Tasks.FileSystemTask.FileSystemTask
Тип Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTask
Комментарии
Службы Integration Services предоставляют несколько разных типов контейнеров для создания пакетов, а TaskHost также один из этих контейнеров. Контейнер TaskHost предоставляет службы для одной задачи. На панели элементов графического конструктора отсутствует соответствующий элемент. Объект TaskHost является объектом-оболочкой для задачи и создается прозрачно во время создания задачи. Он возвращается из Add метода в виде Executable объекта и приводится как .TaskHost Наконец, доступ к экземпляру задачи осуществляется через InnerObject свойство. Дополнительные сведения обо всех контейнерах служб SSIS см. в разделе "Контейнеры служб Integration Services".
Поля
m_executable |
Исполняемый объект. (Унаследовано от Executable) |
Свойства
ApartmentThreaded |
Возвращает или задает значение, указывающее, является ли задача объектом с поддержкой потоков. |
CreationName |
Возвращает строку, используемую для создания экземпляра объекта DtsContainer. Это свойство доступно только для чтения. (Унаследовано от DtsContainer) |
DebugMode |
Возвращает или задает логическое значение, указывающее, находится ли DtsContainer объект в режиме отладки и должен ли он запускать OnBreakpointHit(IDTSBreakpointSite, BreakpointTarget) событие во время выполнения. (Унаследовано от DtsContainer) |
DelayValidation |
Возвращает или задает логическое значение, указывающее, откладывается ли проверка задачи до времени выполнения. Значение по умолчанию — false. (Унаследовано от DtsContainer) |
Description |
Возвращает или задает описание объекта DtsContainer. (Унаследовано от DtsContainer) |
Disable |
Логическое значение, указывающее, отключен ли DtsContainer объект. (Унаследовано от DtsContainer) |
DisableEventHandlers |
Возвращает или задает логическое значение, указывающее, отключены ли обработчики событий в задаче. (Унаследовано от EventsProvider) |
EventHandlers |
Возвращает коллекцию объектов обработчика события. Это поле доступно только для чтения. (Унаследовано от EventsProvider) |
EventInfos |
Возвращает коллекцию объектов EventInfo. Это поле доступно только для чтения. (Унаследовано от EventsProvider) |
ExecutionDuration |
Возвращает значение, указывающее время, затраченное контейнером на выполнение (в миллисекундах). Это свойство доступно только для чтения. (Унаследовано от DtsContainer) |
ExecutionResult |
Возвращает значение, указывающее на успешное или неуспешное выполнение объекта DtsContainer. (Унаследовано от DtsContainer) |
ExecutionStatus |
Возвращает значение, указывающее текущее состояние выполнения объекта DtsContainer во время вызова. (Унаследовано от DtsContainer) |
ExecutionValue |
Возвращает результат выполнения задачи. Это свойство доступно только для чтения. |
ExecValueVariable |
Возвращает или задает пользовательскую переменную Variable, содержащую результаты выполнения задачи. |
FailPackageOnFailure |
Возвращает или задает логическое значение, указывающее, завершается ли сбой пакета при сбое дочернего контейнера. Это свойство используется в контейнерах, а не в самом пакете. (Унаследовано от DtsContainer) |
FailParentOnFailure |
Возвращает или задает значение типа |
ForcedExecutionValue |
ForceExecutionValue Если свойству присвоено значение True, возвращает или задает значение, указывающее необязательное значение выполнения, возвращаемое пакетом. (Унаследовано от DtsContainer) |
ForceExecutionResult |
Возвращает или задает значение перечисления DTSForcedExecResult, указывающее результат принудительного выполнения контейнера. (Унаследовано от DtsContainer) |
ForceExecutionValue |
Возвращает или задает логическое значение, указывающее, должно ли значение выполнения контейнера содержать определенное значение. (Унаследовано от DtsContainer) |
HasExpressions |
Возвращает значение, указывающее, содержит ли указанный объект TaskHost выражения. |
HostType |
Возвращает значение из перечисления DTSObjectHostType, которое описывает узел контейнера. Это свойство доступно только для чтения. |
ID |
Возвращает идентификатор, который представляет собой идентификатор GUID, для DtsContainer. Это значение доступно только для чтения. (Унаследовано от DtsContainer) |
InnerObject |
Возвращает метод, используемый для доступа к экземпляру задачи, размещаемого на TaskHost. |
IsDefaultLocaleID |
Логическое значение, указывающее, использует ли контейнер языковой стандарт по умолчанию. Это свойство доступно только для чтения. (Унаследовано от DtsContainer) |
IsolationLevel |
Возвращает или задает уровень изоляции транзакции в объекте DtsContainer. (Унаследовано от DtsContainer) |
LocaleID |
Возвращает или задает целое число, указывающее языковой стандарт Microsoft Win32®, используемый при DtsContainer выполнении объекта. (Унаследовано от DtsContainer) |
LogEntryInfos |
Возвращает объект LogEntryInfos. Это свойство доступно только для чтения. (Унаследовано от DtsContainer) |
LoggingMode |
Возвращает или задает допустимое значение из перечисления DTSLoggingMode, указывающее режим ведения журнала контейнера. (Унаследовано от DtsContainer) |
LoggingOptions |
Возвращает объект, который содержит свойства, указывающие ресурсы фильтрации и ведения журналов для контейнеров. Это свойство доступно только для чтения. (Унаследовано от DtsContainer) |
MaximumErrorCount |
Возвращает или задает целочисленное значение, указывающее максимальное количество ошибок, которые могут возникнуть до остановки DtsContainer выполнения объекта. (Унаследовано от DtsContainer) |
Name |
Возвращает или задает имя таблицы для объекта DtsContainer. (Унаследовано от DtsContainer) |
Parent |
Возвращает родительский контейнер. Это значение доступно только для чтения. (Унаследовано от DtsContainer) |
Properties |
Возвращает коллекцию DtsProperties, содержащую свойства, связанные с задачей. |
Site |
Возвращает или задает сайт для контейнера. (Унаследовано от DtsContainer) |
StartTime |
Возвращает время начала выполнения контейнером. Это свойство доступно только для чтения. (Унаследовано от DtsContainer) |
StopTime |
Возвращает время завершения выполнения контейнером. Это свойство доступно только для чтения. (Унаследовано от DtsContainer) |
SuspendRequired |
Возвращает или задает логическое значение, указывающее, должны ли задачи приостанавливаться при обнаружении точки останова. Это значение устанавливается подсистемой среды выполнения для задач и контейнеров при обнаружении точки останова. (Унаследовано от DtsContainer) |
TransactionOption |
Возвращает или задает значение перечисления DTSTransactionOption, указывающее, участвует ли контейнер в транзакциях. (Унаследовано от DtsContainer) |
VariableDispenser |
Возвращает объект VariableDispenser, чтобы можно было блокировать переменные, связанные с контейнером. (Унаследовано от DtsContainer) |
Variables |
Возвращает коллекцию, содержащую переменные, связанные с контейнером. Это свойство доступно только для чтения. (Унаследовано от DtsContainer) |
Методы
AcceptBreakpointManager(BreakpointManager) |
Этот метод вызывается средой выполнения при создании задачи или контейнера и передает им диспетчер BreakpointManager, чтобы обеспечить для задачи возможность создания, удаления и проверки состояния точек останова. Этот метод вызывается средой выполнения и не используется в коде. (Унаследовано от DtsContainer) |
ComputeExpressions(Boolean) |
Вычисляет выражения объекта TaskHost. |
Dispose() |
Выполняет определяемые приложением задачи, связанные с удалением, высвобождением или сбросом неуправляемых ресурсов. (Унаследовано от DtsContainer) |
Equals(Object) |
Определяет, равны ли два экземпляра объекта. (Унаследовано от DtsObject) |
Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) |
Выполняет приложение, контейнер или пакет в рамках рабочего процесса пакетов. (Унаследовано от DtsContainer) |
GetExecutionPath() |
Возвращает путь выполнения текущего объекта TaskHost. |
GetExpression(String) |
Возвращает выражение для указанного свойства. Значение NULL означает, что выражение не назначено. |
GetHashCode() |
Возвращает хэш-код данного экземпляра. (Унаследовано от DtsObject) |
GetPackagePath() |
Возвращает путь к местонахождению задачи. |
LoadFromXML(XmlNode, IDTSEvents) |
Вызов этого метода кодом вашего приложения невозможен. Для загрузки пакета, сохраненного в виде XML-файла, используйте метод LoadPackage(String, IDTSEvents). (Унаследовано от DtsContainer) |
ResumeExecution() |
Возобновляет выполнение задачи после приостановки. Задача или контейнер возобновляются средой выполнения. (Унаследовано от DtsContainer) |
SaveToXML(XmlDocument, XmlNode, IDTSEvents) |
Вызов этого метода кодом вашего приложения невозможен. Для сохранения пакета в виде XML-файла используйте метод SaveToXml(String, Package, IDTSEvents). (Унаследовано от DtsContainer) |
SetExpression(String, String) |
Присваивает указанное выражение свойству. Укажите значение NULL, чтобы удалить существующее выражение из свойства. |
SetWrappedExecutable(IDTSExecutable100) |
Возвращает исполняемый объект в оболочке. (Унаследовано от EventsProvider) |
SuspendExecution() |
Вызывается, когда исполняемый объект должен быть приостановлен. Этот метод вызывается средой выполнения. (Унаследовано от DtsContainer) |
Validate(Connections, Variables, IDTSEvents, IDTSLogging) |
Предоставляет контейнеру возможность определить, что он содержит недопустимые настройки, которые могут помешать его успешному выполнению. (Унаследовано от DtsContainer) |
События
Disposed |
Добавляет обработчик события для ожидания события Disposed в компоненте. (Унаследовано от DtsContainer) |