WaitHandle.WaitOne Method

定義

現在の WaitHandle がシグナルを受け取るまで、現在のスレッドをブロックします。 Blocks the current thread until the current WaitHandle receives a signal.

オーバーロード

WaitOne()

現在の WaitHandle がシグナルを受け取るまで、現在のスレッドをブロックします。 Blocks the current thread until the current WaitHandle receives a signal.

WaitOne(Int32)

32 ビット符号付き整数を使用して時間間隔をミリ秒単位で指定し、現在の WaitHandle がシグナルを受信するまで、現在のスレッドをブロックします。 Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval in milliseconds.

WaitOne(TimeSpan)

TimeSpan を使用して時間間隔を指定し、現在のインスタンスがシグナルを受信するまで現在のスレッドをブロックします。 Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

WaitOne(Int32, Boolean)

現在の WaitHandle がシグナルを受信するまで現在のスレッドをブロックします。時間間隔を指定するために 32 ビット符号付き整数を使用し、待機の前でも同期ドメインを終了するかどうかを指定します。 Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval and specifying whether to exit the synchronization domain before the wait.

WaitOne(TimeSpan, Boolean)

現在のインスタンスがシグナルを受信するまで現在のスレッドをブロックします。TimeSpan を使用して時間間隔を指定し、待機の前でも同期ドメインを終了するかどうかを指定します。 Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

WaitOne()

現在の WaitHandle がシグナルを受け取るまで、現在のスレッドをブロックします。 Blocks the current thread until the current WaitHandle receives a signal.

public virtual bool WaitOne ();
戻り値

現在のインスタンスがシグナルを受け取った場合は true true if the current instance receives a signal. 現在のインスタンスがシグナルを受け取らない場合は、WaitOne(Int32, Boolean) はシグナルを受け取るまで待機を続けます。 If the current instance is never signaled, WaitOne(Int32, Boolean) never returns.

例外

現在のインスタンスは既に破棄されています。 The current instance has already been disposed.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。 The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。 This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。 The current instance is a transparent proxy for a WaitHandle in another application domain.

次のコード例では、待機ハンドルを使用して、バック グラウンド スレッドの実行が完了するまで待機する間に終了してから、プロセスを監視する方法を示します。The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   autoEvent->WaitOne(  );
   Console::WriteLine( "Work method signaled.\nMain ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        autoEvent.WaitOne();
        Console.WriteLine("Work method signaled.\nMain ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
Imports System
Imports System.Threading

Public Class WaitOne

    Shared autoEvent As New AutoResetEvent(False)

    <MTAThread> _
    Shared Sub Main()
        Console.WriteLine("Main starting.")

        ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent)

        ' Wait for work method to signal.
        autoEvent.WaitOne()
        Console.WriteLine("Work method signaled.")
        Console.WriteLine("Main ending.")
    End Sub

    Shared Sub WorkMethod(stateInfo As Object) 
        Console.WriteLine("Work starting.")

        ' Simulate time spent working.
        Thread.Sleep(New Random().Next(100, 2000))

        ' Signal that work is finished.
        Console.WriteLine("Work ending.")
        CType(stateInfo, AutoResetEvent).Set()
    End Sub

End Class

注釈

AbandonedMutexException .NET Framework version 2.0 の新機能です。AbandonedMutexException is new in the .NET Framework version 2.0. 以前のバージョンで、WaitOneメソッドを返します。trueミュー テックスが破棄されます。In previous versions, the WaitOne method returns true when a mutex is abandoned. 放棄されたミュー テックスは、多くの場合、深刻なコーディング エラーを示します。An abandoned mutex often indicates a serious coding error. システム全体のミュー テックスを (たとえば、Windows タスク マネージャーを使用して) して、アプリケーションが突然終了されたことが示している可能性があります。In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). 例外には、デバッグに役立つ情報が含まれています。The exception contains information useful for debugging.

このメソッドは、現在のインスタンスまで無期限にブロックの呼び出し元がシグナルを受信します。The caller of this method blocks indefinitely until the current instance receives a signal. このメソッドを使用するまでブロック、WaitHandleが別のスレッドからシグナルを受け取る、非同期操作の完了時に、生成がなど。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

呼び出しと同じですがこのメソッドのオーバー ロードを呼び出し、WaitOne(Int32, Boolean)メソッドのオーバー ロードは、-1 を指定するまたはTimeout.Infinite、最初のパラメーターとfalse2 番目のパラメーター。Calling this method overload is equivalent to calling the WaitOne(Int32, Boolean) method overload and specifying -1 or Timeout.Infinite for the first parameter and false for the second parameter.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

WaitOne(Int32)

32 ビット符号付き整数を使用して時間間隔をミリ秒単位で指定し、現在の WaitHandle がシグナルを受信するまで、現在のスレッドをブロックします。 Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval in milliseconds.

public virtual bool WaitOne (int millisecondsTimeout);
パラメーター
millisecondsTimeout
Int32

待機するミリ秒数。無制限に待機する場合は Infinite (-1)。 The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

戻り値

現在のインスタンスがシグナルを受け取る場合は true。それ以外の場合は false true if the current instance receives a signal; otherwise, false.

例外

現在のインスタンスは既に破棄されています。 The current instance has already been disposed.

millisecondsTimeout は無限のタイムアウトを表す -1 以外の負の数です。 millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。 The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。 This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。 The current instance is a transparent proxy for a WaitHandle in another application domain.

次のコード例では、待機ハンドルを使用して、バック グラウンド スレッドの実行が完了するまで待機する間に終了してから、プロセスを監視する方法を示します。The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   if ( autoEvent->WaitOne( 1000 ) )
   {
      Console::WriteLine( "Work method signaled." );
   }
   else
   {
      Console::WriteLine( "Timed out waiting for work "
      "method to signal." );
   }

   Console::WriteLine( "Main ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        if(autoEvent.WaitOne(1000))
        {
            Console.WriteLine("Work method signaled.");
        }
        else
        {
            Console.WriteLine("Timed out waiting for work " +
                "method to signal.");
        }
        Console.WriteLine("Main ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
Imports System
Imports System.Threading

Public Class WaitOne

    Shared autoEvent As New AutoResetEvent(False)

    <MTAThread> _
    Shared Sub Main()
        Console.WriteLine("Main starting.")

        ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent)

        ' Wait for work method to signal.
        If autoEvent.WaitOne(1000) Then
            Console.WriteLine("Work method signaled.")
        Else
            Console.WriteLine("Timed out waiting for work " & _
                "method to signal.")
        End If

        Console.WriteLine("Main ending.")
    End Sub

    Shared Sub WorkMethod(stateInfo As Object) 
        Console.WriteLine("Work starting.")

        ' Simulate time spent working.
        Thread.Sleep(New Random().Next(100, 2000))

        ' Signal that work is finished.
        Console.WriteLine("Work ending.")
        CType(stateInfo, AutoResetEvent).Set()
    End Sub

End Class

注釈

場合millisecondsTimeoutが 0 の場合、メソッドはブロックしません。If millisecondsTimeout is zero, the method does not block. これにより、待機ハンドルの状態をテストし、すぐに返します。It tests the state of the wait handle and returns immediately.

現在のインスタンスがシグナルまたはタイムアウトを受信するまでこのメソッドはブロックの呼び出し元に発生します。The caller of this method blocks until the current instance receives a signal or a time-out occurs. このメソッドを使用するまでブロック、WaitHandleが別のスレッドからシグナルを受け取る、非同期操作の完了時に、生成がなど。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

呼び出しと同じには、このメソッドのオーバー ロードを呼び出し、WaitOne(Int32, Boolean)オーバー ロードを指定してfalseexitContextします。Calling this method overload is the same as calling the WaitOne(Int32, Boolean) overload and specifying false for exitContext.

WaitOne(TimeSpan)

TimeSpan を使用して時間間隔を指定し、現在のインスタンスがシグナルを受信するまで現在のスレッドをブロックします。 Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

public virtual bool WaitOne (TimeSpan timeout);
パラメーター
timeout
TimeSpan

待機するミリ秒数を表す TimeSpan。無制限に待機する場合は、-1 ミリ秒を表す TimeSpan A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

戻り値

現在のインスタンスがシグナルを受け取る場合は true。それ以外の場合は false true if the current instance receives a signal; otherwise, false.

例外

現在のインスタンスは既に破棄されています。 The current instance has already been disposed.

timeout は無限のタイムアウトを表す -1 ミリ秒以外の負の数です。 timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. - または - -or- timeoutMaxValue より大きくなっています。 timeout is greater than MaxValue.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。 The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。 This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。 The current instance is a transparent proxy for a WaitHandle in another application domain.

注釈

場合timeoutが 0 の場合、メソッドはブロックしません。If timeout is zero, the method does not block. これにより、待機ハンドルの状態をテストし、すぐに返します。It tests the state of the wait handle and returns immediately.

現在のインスタンスがシグナルまたはタイムアウトを受信するまでこのメソッドはブロックの呼び出し元に発生します。The caller of this method blocks until the current instance receives a signal or a time-out occurs. このメソッドを使用するまでブロック、WaitHandleが別のスレッドからシグナルを受け取る、非同期操作の完了時に、生成がなど。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

最大値timeoutInt32.MaxValueします。The maximum value for timeout is Int32.MaxValue.

呼び出しと同じには、このメソッドのオーバー ロードを呼び出し、WaitOne(TimeSpan, Boolean)オーバー ロードを指定してfalseexitContextします。Calling this method overload is the same as calling the WaitOne(TimeSpan, Boolean) overload and specifying false for exitContext.

WaitOne(Int32, Boolean)

現在の WaitHandle がシグナルを受信するまで現在のスレッドをブロックします。時間間隔を指定するために 32 ビット符号付き整数を使用し、待機の前でも同期ドメインを終了するかどうかを指定します。 Blocks the current thread until the current WaitHandle receives a signal, using a 32-bit signed integer to specify the time interval and specifying whether to exit the synchronization domain before the wait.

public virtual bool WaitOne (int millisecondsTimeout, bool exitContext);
パラメーター
millisecondsTimeout
Int32

待機するミリ秒数。無制限に待機する場合は Infinite (-1)。 The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

exitContext
Boolean

待機する前にコンテキストの同期ドメインを終了し (同期されたコンテキスト内にいる場合)、後で再取得する場合は、true。それ以外の場合は false true to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

戻り値

現在のインスタンスがシグナルを受け取る場合は true。それ以外の場合は false true if the current instance receives a signal; otherwise, false.

例外

現在のインスタンスは既に破棄されています。 The current instance has already been disposed.

millisecondsTimeout は無限のタイムアウトを表す -1 以外の負の数です。 millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。 The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。 This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。 The current instance is a transparent proxy for a WaitHandle in another application domain.

次の例は、どのようにWaitOne(Int32, Boolean)同期ドメイン内で呼び出されたときのメソッドのオーバー ロードの動作します。The following example shows how the WaitOne(Int32, Boolean) method overload behaves when it is called within a synchronization domain. 最初に、スレッドが待機するexitContext設定falseし、待機がタイムアウトになるまでブロックします。First, a thread waits with exitContext set to false and blocks until the wait timeout expires. 2 番目のスレッドを実行後、最初のスレッドを終了し、待つexitContextに設定trueします。A second thread executes after the first thread terminates and waits with exitContext set to true. この 2 つ目のスレッドの待機ハンドルの通知への呼び出しがブロックされていないと、印刷待ちタイムアウトする前に、スレッドが完了するとします。The call to signal the wait handle for this second thread is not blocked, and the thread completes before the wait timeout.

using namespace System;
using namespace System::Threading;
using namespace System::Runtime::Remoting::Contexts;

[Synchronization(true)]
public ref class SyncingClass : ContextBoundObject
{
private:
    EventWaitHandle^ waitHandle;

public:
    SyncingClass()
    {
         waitHandle =
            gcnew EventWaitHandle(false, EventResetMode::ManualReset);
    }

    void Signal()
    {
        Console::WriteLine("Thread[{0:d4}]: Signalling...", Thread::CurrentThread->GetHashCode());
        waitHandle->Set();
    }

    void DoWait(bool leaveContext)
    {
        bool signalled;

        waitHandle->Reset();
        Console::WriteLine("Thread[{0:d4}]: Waiting...", Thread::CurrentThread->GetHashCode());
        signalled = waitHandle->WaitOne(3000, leaveContext);
        if (signalled)
        {
            Console::WriteLine("Thread[{0:d4}]: Wait released!!!", Thread::CurrentThread->GetHashCode());
        }
        else
        {
            Console::WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread::CurrentThread->GetHashCode());
        }
    }
};

public ref class TestSyncDomainWait
{
public:
    static void Main()
    {
        SyncingClass^ syncClass = gcnew SyncingClass();

        Thread^ runWaiter;

        Console::WriteLine("\nWait and signal INSIDE synchronization domain:\n");
        runWaiter = gcnew Thread(gcnew ParameterizedThreadStart(&TestSyncDomainWait::RunWaitKeepContext));
        runWaiter->Start(syncClass);
        Thread::Sleep(1000);
        Console::WriteLine("Thread[{0:d4}]: Signal...", Thread::CurrentThread->GetHashCode());
        // This call to Signal will block until the timeout in DoWait expires.
        syncClass->Signal();
        runWaiter->Join();

        Console::WriteLine("\nWait and signal OUTSIDE synchronization domain:\n");
        runWaiter = gcnew Thread(gcnew ParameterizedThreadStart(&TestSyncDomainWait::RunWaitLeaveContext));
        runWaiter->Start(syncClass);
        Thread::Sleep(1000);
        Console::WriteLine("Thread[{0:d4}]: Signal...", Thread::CurrentThread->GetHashCode());
        // This call to Signal is unblocked and will set the wait handle to
        // release the waiting thread.
        syncClass->Signal();
        runWaiter->Join();
    }

    static void RunWaitKeepContext(Object^ parm)
    {
        ((SyncingClass^)parm)->DoWait(false);
    }

    static void RunWaitLeaveContext(Object^ parm)
    {
        ((SyncingClass^)parm)->DoWait(true);
    }
};

int main()
{
    TestSyncDomainWait::Main();
}
// The output for the example program will be similar to the following:
//
// Wait and signal INSIDE synchronization domain:
//
// Thread[0004]: Waiting...
// Thread[0001]: Signal...
// Thread[0004]: Wait timeout!!!
// Thread[0001]: Signalling...
//
// Wait and signal OUTSIDE synchronization domain:
//
// Thread[0006]: Waiting...
// Thread[0001]: Signal...
// Thread[0001]: Signalling...
// Thread[0006]: Wait released!!!
using System;
using System.Threading;
using System.Runtime.Remoting.Contexts;

[Synchronization(true)]
public class SyncingClass : ContextBoundObject
{
    private EventWaitHandle waitHandle;

    public SyncingClass()
    {
         waitHandle =
            new EventWaitHandle(false, EventResetMode.ManualReset);
    }

    public void Signal()
    {
        Console.WriteLine("Thread[{0:d4}]: Signalling...", Thread.CurrentThread.GetHashCode());
        waitHandle.Set();
    }

    public void DoWait(bool leaveContext)
    {
        bool signalled;

        waitHandle.Reset();
        Console.WriteLine("Thread[{0:d4}]: Waiting...", Thread.CurrentThread.GetHashCode());
        signalled = waitHandle.WaitOne(3000, leaveContext);
        if (signalled)
        {
            Console.WriteLine("Thread[{0:d4}]: Wait released!!!", Thread.CurrentThread.GetHashCode());
        }
        else
        {
            Console.WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread.CurrentThread.GetHashCode());
        }
    }
}

public class TestSyncDomainWait
{
    public static void Main()
    {
        SyncingClass syncClass = new SyncingClass();

        Thread runWaiter;

        Console.WriteLine("\nWait and signal INSIDE synchronization domain:\n");
        runWaiter = new Thread(RunWaitKeepContext);
        runWaiter.Start(syncClass);
        Thread.Sleep(1000);
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode());
        // This call to Signal will block until the timeout in DoWait expires.
        syncClass.Signal();
        runWaiter.Join();

        Console.WriteLine("\nWait and signal OUTSIDE synchronization domain:\n");
        runWaiter = new Thread(RunWaitLeaveContext);
        runWaiter.Start(syncClass);
        Thread.Sleep(1000);
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode());
        // This call to Signal is unblocked and will set the wait handle to
        // release the waiting thread.
        syncClass.Signal();
        runWaiter.Join();
    }

    public static void RunWaitKeepContext(object parm)
    {
        ((SyncingClass)parm).DoWait(false);
    }

    public static void RunWaitLeaveContext(object parm)
    {
        ((SyncingClass)parm).DoWait(true);
    }
}

// The output for the example program will be similar to the following:
//
// Wait and signal INSIDE synchronization domain:
//
// Thread[0004]: Waiting...
// Thread[0001]: Signal...
// Thread[0004]: Wait timeout!!!
// Thread[0001]: Signalling...
//
// Wait and signal OUTSIDE synchronization domain:
//
// Thread[0006]: Waiting...
// Thread[0001]: Signal...
// Thread[0001]: Signalling...
// Thread[0006]: Wait released!!!
Imports System
Imports System.Threading
Imports System.Runtime.Remoting.Contexts

<Synchronization(true)>
Public Class SyncingClass
    Inherits ContextBoundObject
    
    Private waitHandle As EventWaitHandle

    Public Sub New()
         waitHandle = New EventWaitHandle(false, EventResetMode.ManualReset)
    End Sub

    Public Sub Signal()
        Console.WriteLine("Thread[{0:d4}]: Signalling...", Thread.CurrentThread.GetHashCode())
        waitHandle.Set()
    End Sub

    Public Sub DoWait(leaveContext As Boolean)
        Dim signalled As Boolean

        waitHandle.Reset()
        Console.WriteLine("Thread[{0:d4}]: Waiting...", Thread.CurrentThread.GetHashCode())
        signalled = waitHandle.WaitOne(3000, leaveContext)
        If signalled Then
            Console.WriteLine("Thread[{0:d4}]: Wait released!!!", Thread.CurrentThread.GetHashCode())
        Else
            Console.WriteLine("Thread[{0:d4}]: Wait timeout!!!", Thread.CurrentThread.GetHashCode())
        End If
    End Sub
End Class

Public Class TestSyncDomainWait
    Public Shared Sub Main()
        Dim syncClass As New SyncingClass()

        Dim runWaiter As Thread

        Console.WriteLine(vbNewLine + "Wait and signal INSIDE synchronization domain:" + vbNewLine)
        runWaiter = New Thread(AddressOf RunWaitKeepContext)
        runWaiter.Start(syncClass)
        Thread.Sleep(1000)
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode())
        ' This call to Signal will block until the timeout in DoWait expires.
        syncClass.Signal()
        runWaiter.Join()

        Console.WriteLine(vbNewLine + "Wait and signal OUTSIDE synchronization domain:" + vbNewLine)
        runWaiter = New Thread(AddressOf RunWaitLeaveContext)
        runWaiter.Start(syncClass)
        Thread.Sleep(1000)
        Console.WriteLine("Thread[{0:d4}]: Signal...", Thread.CurrentThread.GetHashCode())
        ' This call to Signal is unblocked and will set the wait handle to
        ' release the waiting thread.
        syncClass.Signal()
        runWaiter.Join()
    End Sub

    Public Shared Sub RunWaitKeepContext(parm As Object)
        Dim syncClass As SyncingClass = CType(parm, SyncingClass)
        syncClass.DoWait(False)
    End Sub

    Public Shared Sub RunWaitLeaveContext(parm As Object)
        Dim syncClass As SyncingClass = CType(parm, SyncingClass)
        syncClass.DoWait(True)
    End Sub
End Class

' The output for the example program will be similar to the following:
'
' Wait and signal INSIDE synchronization domain:
'
' Thread[0004]: Waiting...
' Thread[0001]: Signal...
' Thread[0004]: Wait timeout!!!
' Thread[0001]: Signalling...
'
' Wait and signal OUTSIDE synchronization domain:
'
' Thread[0006]: Waiting...
' Thread[0001]: Signal...
' Thread[0001]: Signalling...
' Thread[0006]: Wait released!!!

注釈

場合millisecondsTimeoutが 0 の場合、メソッドはブロックしません。If millisecondsTimeout is zero, the method does not block. これにより、待機ハンドルの状態をテストし、すぐに返します。It tests the state of the wait handle and returns immediately.

AbandonedMutexException .NET Framework version 2.0 の新機能です。AbandonedMutexException is new in the .NET Framework version 2.0. 以前のバージョンで、WaitOneメソッドを返します。trueミュー テックスが破棄されます。In previous versions, the WaitOne method returns true when a mutex is abandoned. 放棄されたミュー テックスは、多くの場合、深刻なコーディング エラーを示します。An abandoned mutex often indicates a serious coding error. システム全体のミュー テックスを (たとえば、Windows タスク マネージャーを使用して) して、アプリケーションが突然終了されたことが示している可能性があります。In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). 例外には、デバッグに役立つ情報が含まれています。The exception contains information useful for debugging.

現在のインスタンスがシグナルまたはタイムアウトを受信するまでこのメソッドはブロックの呼び出し元に発生します。The caller of this method blocks until the current instance receives a signal or a time-out occurs. このメソッドを使用するまでブロック、WaitHandleが別のスレッドからシグナルを受け取る、非同期操作の完了時に、生成がなど。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

コンテキストの終了時の注意Notes on Exiting the Context

exitContextパラメーターには効果がない場合を除き、WaitOne既定以外の管理対象のコンテキスト内からメソッドが呼び出されます。The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. 派生したクラスのインスタンスへの呼び出し、スレッドが場合に生じるContextBoundObjectします。This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. 派生していないクラスでメソッドを現在実行している場合でもContextBoundObjectと同様に、 String、既定以外のコンテキストであることができる場合、ContextBoundObjectが現在のアプリケーション ドメインで、スタック上にします。Even if you are currently executing a method on a class that does not derive from ContextBoundObject, like String, you can be in a nondefault context if a ContextBoundObject is on your stack in the current application domain.

既定以外のコンテキストでコードを実行しているときに指定するtrueexitContextが原因で、既定以外の管理コンテキストを終了するスレッド (つまり、既定のコンテキストへの移行) 実行する前に、WaitOneメソッド。When your code is executing in a nondefault context, specifying true for exitContext causes the thread to exit the nondefault managed context (that is, to transition to the default context) before executing the WaitOne method. 呼び出し後、スレッドが元の既定以外のコンテキストに戻る、WaitOneメソッドが完了するとします。The thread returns to the original nondefault context after the call to the WaitOne method completes.

これは、便利な場合、コンテキスト バインド クラスにはSynchronizationAttributeします。This can be useful when the context-bound class has SynchronizationAttribute. その場合は、クラスのメンバーに対するすべての呼び出しを自動的に同期し、同期ドメインは、クラスのコードの本文全体。In that case, all calls to members of the class are automatically synchronized, and the synchronization domain is the entire body of code for the class. メンバーの呼び出し履歴内のコードを呼び出すかどうか、WaitOneメソッドを指定してtrueexitContextスレッドが続行する、オブジェクトのすべてのメンバーへの呼び出しでブロックされているスレッドを許可する、同期ドメインを終了します。If code in the call stack of a member calls the WaitOne method and specifies true for exitContext, the thread exits the synchronization domain, allowing a thread that is blocked on a call to any member of the object to proceed. ときに、WaitOneメソッドが戻る呼び出しを行ったスレッドが同期ドメインを再入力を待つ必要があります。When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

WaitOne(TimeSpan, Boolean)

現在のインスタンスがシグナルを受信するまで現在のスレッドをブロックします。TimeSpan を使用して時間間隔を指定し、待機の前でも同期ドメインを終了するかどうかを指定します。 Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval and specifying whether to exit the synchronization domain before the wait.

public virtual bool WaitOne (TimeSpan timeout, bool exitContext);
パラメーター
timeout
TimeSpan

待機するミリ秒数を表す TimeSpan。無制限に待機する場合は、-1 ミリ秒を表す TimeSpan A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

exitContext
Boolean

待機する前にコンテキストの同期ドメインを終了し (同期されたコンテキスト内にいる場合)、後で再取得する場合は、true。それ以外の場合は false true to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

戻り値

現在のインスタンスがシグナルを受け取る場合は true。それ以外の場合は false true if the current instance receives a signal; otherwise, false.

例外

現在のインスタンスは既に破棄されています。 The current instance has already been disposed.

timeout は無限のタイムアウトを表す -1 ミリ秒以外の負の数です。 timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. - または - -or- timeoutMaxValue より大きくなっています。 timeout is greater than MaxValue.

スレッドがミューテックスを解放せずに終了したため、待機が完了しました。 The wait completed because a thread exited without releasing a mutex. Windows 98 または Windows Millennium Edition では、この例外はスローされません。 This exception is not thrown on Windows 98 or Windows Millennium Edition.

別のアプリケーション ドメインでは、現在のインスタンスは WaitHandle の透過プロキシです。 The current instance is a transparent proxy for a WaitHandle in another application domain.

次のコード例では、待機ハンドルを使用して、バック グラウンド スレッドの実行が完了するまで待機する間に終了してから、プロセスを監視する方法を示します。The following code example shows how to use a wait handle to keep a process from terminating while it waits for a background thread to finish executing.

using namespace System;
using namespace System::Threading;
ref class WaitOne
{
private:
   WaitOne(){}


public:
   static void WorkMethod( Object^ stateInfo )
   {
      Console::WriteLine( "Work starting." );
      
      // Simulate time spent working.
      Thread::Sleep( (gcnew Random)->Next( 100, 2000 ) );
      
      // Signal that work is finished.
      Console::WriteLine( "Work ending." );
      dynamic_cast<AutoResetEvent^>(stateInfo)->Set();
   }

};

int main()
{
   Console::WriteLine( "Main starting." );
   AutoResetEvent^ autoEvent = gcnew AutoResetEvent( false );
   ThreadPool::QueueUserWorkItem( gcnew WaitCallback( &WaitOne::WorkMethod ), autoEvent );
   
   // Wait for work method to signal.
   if ( autoEvent->WaitOne( TimeSpan(0,0,1), false ) )
   {
      Console::WriteLine( "Work method signaled." );
   }
   else
   {
      Console::WriteLine( "Timed out waiting for work "
      "method to signal." );
   }

   Console::WriteLine( "Main ending." );
}

using System;
using System.Threading;

class WaitOne
{
    static AutoResetEvent autoEvent = new AutoResetEvent(false);

    static void Main()
    {
        Console.WriteLine("Main starting.");

        ThreadPool.QueueUserWorkItem(
            new WaitCallback(WorkMethod), autoEvent);

        // Wait for work method to signal.
        if(autoEvent.WaitOne(new TimeSpan(0, 0, 1), false))
        {
            Console.WriteLine("Work method signaled.");
        }
        else
        {
            Console.WriteLine("Timed out waiting for work " +
                "method to signal.");
        }
        Console.WriteLine("Main ending.");
    }

    static void WorkMethod(object stateInfo) 
    {
        Console.WriteLine("Work starting.");

        // Simulate time spent working.
        Thread.Sleep(new Random().Next(100, 2000));

        // Signal that work is finished.
        Console.WriteLine("Work ending.");
        ((AutoResetEvent)stateInfo).Set();
    }
}
Imports System
Imports System.Threading

Public Class WaitOne

    Shared autoEvent As New AutoResetEvent(False)

    <MTAThread> _
    Shared Sub Main()
        Console.WriteLine("Main starting.")

        ThreadPool.QueueUserWorkItem(AddressOf WorkMethod, autoEvent)

        ' Wait for work method to signal.
        If autoEvent.WaitOne(New TimeSpan(0, 0, 1), False) Then
            Console.WriteLine("Work method signaled.")
        Else
            Console.WriteLine("Timed out waiting for work " & _
                "method to signal.")
        End If

        Console.WriteLine("Main ending.")
    End Sub

    Shared Sub WorkMethod(stateInfo As Object) 
        Console.WriteLine("Work starting.")

        ' Simulate time spent working.
        Thread.Sleep(New Random().Next(100, 2000))

        ' Signal that work is finished.
        Console.WriteLine("Work ending.")
        CType(stateInfo, AutoResetEvent).Set()
    End Sub

End Class

注釈

場合timeoutが 0 の場合、メソッドはブロックしません。If timeout is zero, the method does not block. これにより、待機ハンドルの状態をテストし、すぐに返します。It tests the state of the wait handle and returns immediately.

AbandonedMutexException .NET Framework version 2.0 の新機能です。AbandonedMutexException is new in the .NET Framework version 2.0. 以前のバージョンで、WaitOneメソッドを返します。trueミュー テックスが破棄されます。In previous versions, the WaitOne method returns true when a mutex is abandoned. 放棄されたミュー テックスは、多くの場合、深刻なコーディング エラーを示します。An abandoned mutex often indicates a serious coding error. システム全体のミュー テックスを (たとえば、Windows タスク マネージャーを使用して) して、アプリケーションが突然終了されたことが示している可能性があります。In the case of a system-wide mutex, it might indicate that an application has been terminated abruptly (for example, by using Windows Task Manager). 例外には、デバッグに役立つ情報が含まれています。The exception contains information useful for debugging.

現在のインスタンスがシグナルまたはタイムアウトを受信するまでこのメソッドはブロックの呼び出し元に発生します。The caller of this method blocks until the current instance receives a signal or a time-out occurs. このメソッドを使用するまでブロック、WaitHandleが別のスレッドからシグナルを受け取る、非同期操作の完了時に、生成がなど。Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. 詳細については、IAsyncResult インターフェイスのトピックを参照してください。For more information, see the IAsyncResult interface.

派生クラスの動作をカスタマイズするには、このメソッドをオーバーライドします。Override this method to customize the behavior of derived classes.

最大値timeoutInt32.MaxValueします。The maximum value for timeout is Int32.MaxValue.

コンテキストの終了時の注意Notes on Exiting the Context

exitContextパラメーターには効果がない場合を除き、WaitOne既定以外の管理対象のコンテキスト内からメソッドが呼び出されます。The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. 派生したクラスのインスタンスへの呼び出し、スレッドが場合に生じるContextBoundObjectします。This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. 派生していないクラスでメソッドを現在実行している場合でもContextBoundObjectと同様に、 String、既定以外のコンテキストであることができる場合、ContextBoundObjectが現在のアプリケーション ドメインで、スタック上にします。Even if you are currently executing a method on a class that does not derive from ContextBoundObject, like String, you can be in a nondefault context if a ContextBoundObject is on your stack in the current application domain.

既定以外のコンテキストでコードを実行しているときに指定するtrueexitContextが原因で、既定以外の管理コンテキストを終了するスレッド (つまり、既定のコンテキストへの移行) 実行する前に、WaitOneメソッド。When your code is executing in a nondefault context, specifying true for exitContext causes the thread to exit the nondefault managed context (that is, to transition to the default context) before executing the WaitOne method. 呼び出し後、スレッドが元の既定以外のコンテキストに戻る、WaitOneメソッドが完了するとします。The thread returns to the original nondefault context after the call to the WaitOne method completes.

これは、便利な場合、コンテキスト バインド クラスにはSynchronizationAttributeします。This can be useful when the context-bound class has SynchronizationAttribute. その場合は、クラスのメンバーに対するすべての呼び出しを自動的に同期し、同期ドメインは、クラスのコードの本文全体。In that case, all calls to members of the class are automatically synchronized, and the synchronization domain is the entire body of code for the class. メンバーの呼び出し履歴内のコードを呼び出すかどうか、WaitOneメソッドを指定してtrueexitContextスレッドが続行する、オブジェクトのすべてのメンバーへの呼び出しでブロックされているスレッドを許可する、同期ドメインを終了します。If code in the call stack of a member calls the WaitOne method and specifies true for exitContext, the thread exits the synchronization domain, allowing a thread that is blocked on a call to any member of the object to proceed. ときに、WaitOneメソッドが戻る呼び出しを行ったスレッドが同期ドメインを再入力を待つ必要があります。When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

適用対象