TaskHost クラス

リファレンス

定義

名前空間:: Microsoft.SqlServer.Dts.Runtime

アセンブリ:: Microsoft.SqlServer.ManagedDTS.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

単一のタスクをカプセル化するコンテナーを提供します。 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

継承: Object

DtsObject

Executable

DtsContainer

EventsProvider
TaskHost

実装: IDTSExecutionPath IDTSObjectHost IDTSPackagePath IDTSPropertiesProvider IDTSPropertiesProviderEx

例

次のコード例は、空のパッケージの作成を示しています。 2 つのタスクをパッケージに追加し、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

サンプル出力:

Type Microsoft.SqlServer.Dts.Tasks.FileSystemTask.FileSystemTask

Type Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTask

注釈

Integration Services には、パッケージを構築するためのいくつかの異なる種類のコンテナーが TaskHost 用意されており、それらのコンテナーの 1 つです。 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	子コンテナーが失敗したときに親コンテナーが失敗するかどうかを定義する `Boolean` を取得または設定します。 (継承元 DtsContainer)
ForcedExecutionValue	プロパティが ForceExecutionValue True に設定されている場合は、パッケージから返される省略可能な実行値を指定する値を取得または設定します。 (継承元 DtsContainer)
ForceExecutionResult	コンテナーの強制実行結果を指定する DTSForcedExecResult 列挙値を取得または設定します。 (継承元 DtsContainer)
ForceExecutionValue	コンテナーの実行値に特定の値を強制的に含めるかどうかを示すブール値を取得または設定します。 (継承元 DtsContainer)
HasExpressions	TaskHost オブジェクトが式を持つかどうかを示す値を取得します。
HostType	コンテナーのホストを示す値を DTSObjectHostType 列挙から取得します。このプロパティは読み取り専用です。
ID	DtsContainer の ID を返します。この ID は GUID です。この値は読み取り専用です。 (継承元 DtsContainer)
InnerObject	TaskHost がホストするタスクインスタンスへのアクセスに使用されるメソッドを取得します。
IsDefaultLocaleID	コンテナーが既定のロケールを使用するかどうかを示すブール値。このプロパティは読み取り専用です。 (継承元 DtsContainer)
IsolationLevel	DtsContainer オブジェクト内のトランザクションの分離レベルを取得または設定します。 (継承元 DtsContainer)
LocaleID	オブジェクトの実行時に使用する Microsoft Win32® localeID を示す整数型 (Integer) を 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)	2 つのオブジェクトインスタンスが等しいかどうかを判断します。 (継承元 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)

適用対象

次の方法で共有