Task.WaitForMe Property

親コンテナがこのタスクの完了を待機するかどうかを示す Boolean 値を返します。このプロパティは読み取り専用です。

名前空間: Microsoft.SqlServer.Dts.Runtime
アセンブリ: Microsoft.SqlServer.ManagedDTS (microsoft.sqlserver.manageddts.dll 内)

構文

'宣言
<BrowsableAttribute(False)> _
Public Overridable ReadOnly Property WaitForMe As Boolean

[BrowsableAttribute(false)] 
public virtual bool WaitForMe { get; }

[BrowsableAttribute(false)] 
public:
virtual property bool WaitForMe {
    bool get ();
}

/** @property */
public boolean get_WaitForMe ()

public function get WaitForMe () : boolean

プロパティ値

コンテナがタスクを待機するかどうかを示す Boolean 値です。true に設定すると、コンテナはタスクの完了まで待機します。その後、コンテナはタスクの完了を通知します。

解説

任意のタスクが完了した時点で、ランタイムはコンテナ内でまだ実行されているタスクを調べ、いずれかのタスクの WaitForMe が false に設定されている場合、それらのタスクは取り消されます。これによって、コンテナの完了をブロックしないタスクを持つことができます。たとえば、イベントが原因でコンテナを完了できないため、ある期間だけイベントをリッスンすることが必要な場合があります。関心のあるタスクに対してのみ WaitForMe を true に設定し、タスクが実行されている間に限ってイベントをリッスンできます。タスクが完了したら、イベントのリッスンを停止できます。

使用例

次のコード例では、Task から継承されるメール送信タスクを作成してから、継承されたプロパティを表示します。

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Tasks.SendMailTask;

namespace Microsoft.SqlServer.SSIS.Samples
{
    class Program
    {
        static void Main(string[] args)
        {
            Application app = new Application();
            Package pkg = new Package();
            // Add a Send Mail task to the package.
            Executable exec = pkg.Executables.Add("STOCK:SendMailTask");

            // Cast the task to its own class.
            TaskHost th = exec as TaskHost;
            SendMailTask smTask = th.InnerObject as SendMailTask;

            // Display the properties inherited from Task.
            Console.WriteLine("ExecutionValue: {0}", smTask.ExecutionValue);
            Console.WriteLine("Version: {0}", smTask.Version);
            Console.WriteLine("WaitForMe: {0}", smTask.WaitForMe);
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Tasks.SendMailTask
 
Namespace Microsoft.SqlServer.SSIS.Samples
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim app As Application =  New Application() 
            Dim pkg As Package =  New Package() 
            ' Add a Send Mail task to the package.
            Dim exec As Executable =  pkg.Executables.Add("STOCK:SendMailTask") 
 
            ' Cast the task to its own class.
            Dim th As TaskHost =  exec as TaskHost 
            Dim smTask As SendMailTask =  th.InnerObject as SendMailTask 
 
            ' Display the properties inherited from Task.
            Console.WriteLine("ExecutionValue: {0}", smTask.ExecutionValue)
            Console.WriteLine("Version: {0}", smTask.Version)
            Console.WriteLine("WaitForMe: {0}", smTask.WaitForMe)
        End Sub
    End Class
End Namespace

サンプル出力 :

ExecutionValue:

Version: 0

WaitForMe: True

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

Task Class
Task Members
Microsoft.SqlServer.Dts.Runtime Namespace