WaitHandle.WaitOne Méthode

Définition

Bloque le thread actuel jusqu'à ce que le WaitHandle actuel reçoive un signal.Blocks the current thread until the current WaitHandle receives a signal.

Surcharges

WaitOne()

Bloque le thread actuel jusqu'à ce que le WaitHandle actuel reçoive un signal.Blocks the current thread until the current WaitHandle receives a signal.

WaitOne(Int32)

Bloque le thread actuel jusqu'à ce que le WaitHandle actuel reçoive un signal, en utilisant un entier signé 32 bits pour spécifier l'intervalle de temps.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)

Bloque le thread actuel jusqu'à ce que l'instance actuelle reçoive un signal, en utilisant une valeur TimeSpan pour spécifier l'intervalle de temps.Blocks the current thread until the current instance receives a signal, using a TimeSpan to specify the time interval.

WaitOne(Int32, Boolean)

Bloque le thread actuel jusqu’à ce que le WaitHandle actuel reçoive un signal, en utilisant un entier signé 32 bits pour spécifier l’intervalle de temps et en spécifiant s’il faut quitter le domaine de synchronisation avant l’attente.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)

Bloque le thread actuel jusqu'à ce que l'instance actuelle reçoive un signal, en utilisant une valeur TimeSpan pour spécifier l'intervalle de temps et en spécifiant s'il faut quitter le domaine de synchronisation avant l'attente.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()

Bloque le thread actuel jusqu'à ce que le WaitHandle actuel reçoive un signal.Blocks the current thread until the current WaitHandle receives a signal.

public:
 virtual bool WaitOne();
public virtual bool WaitOne ();
abstract member WaitOne : unit -> bool
override this.WaitOne : unit -> bool
Public Overridable Function WaitOne () As Boolean

Retours

true si l'instance actuelle reçoit un signal.true if the current instance receives a signal. Si l'instance actuelle ne reçoit jamais de signal, WaitOne() ne retourne jamais.If the current instance is never signaled, WaitOne() never returns.

Exceptions

L’instance actuelle a déjà été supprimée.The current instance has already been disposed.

L’attente s’est arrêtée, car un thread s’est terminé sans libérer de mutex.The wait completed because a thread exited without releasing a mutex. Cette exception n’est pas levée sur Windows 98 ou Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

L'instance actuelle est un proxy transparent pour un WaitHandle dans un autre domaine d'application.The current instance is a transparent proxy for a WaitHandle in another application domain.

Exemples

L’exemple de code suivant montre comment utiliser un handle d’attente pour empêcher un processus de se terminer pendant qu’il attend la fin de l’exécution d’un thread d’arrière-plan.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.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

Remarques

AbandonedMutexException est une nouveauté de la version 2,0 de .NET Framework.AbandonedMutexException is new in the .NET Framework version 2.0. Dans les versions précédentes, la méthode WaitOne retourne true lorsqu’un mutex est abandonné.In previous versions, the WaitOne method returns true when a mutex is abandoned. Un mutex abandonné indique souvent une erreur de codage grave.An abandoned mutex often indicates a serious coding error. Dans le cas d’un mutex à l’ensemble du système, cela peut indiquer qu’une application a été interrompue brusquement (par exemple, à l’aide du gestionnaire des tâches 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). L’exception contient des informations utiles pour le débogage.The exception contains information useful for debugging.

L’appelant de cette méthode bloque indéfiniment jusqu’à ce que l’instance actuelle reçoive un signal.The caller of this method blocks indefinitely until the current instance receives a signal. Utilisez cette méthode pour bloquer jusqu’à ce qu’un WaitHandle reçoive un signal d’un autre thread, tel que est généré lorsqu’une opération asynchrone se termine.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Pour plus d’informations, consultez l’interface IAsyncResult.For more information, see the IAsyncResult interface.

L’appel de cette surcharge de méthode équivaut à appeler la surcharge de méthode WaitOne(Int32, Boolean) et à spécifier-1 ou Timeout.Infinite pour le premier paramètre et false pour le deuxième paramètre.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.

Substituez cette méthode pour personnaliser le comportement des classes dérivées.Override this method to customize the behavior of derived classes.

WaitOne(Int32)

Bloque le thread actuel jusqu'à ce que le WaitHandle actuel reçoive un signal, en utilisant un entier signé 32 bits pour spécifier l'intervalle de temps.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);
public virtual bool WaitOne (int millisecondsTimeout);
abstract member WaitOne : int -> bool
override this.WaitOne : int -> bool
Public Overridable Function WaitOne (millisecondsTimeout As Integer) As Boolean

Paramètres

millisecondsTimeout
Int32

Nombre de millisecondes à attendre, ou Infinite (-1) pour un délai d'attente infini.The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

Retours

true si l'instance actuelle reçoit un signal ; sinon, false.true if the current instance receives a signal; otherwise, false.

Exceptions

L’instance actuelle a déjà été supprimée.The current instance has already been disposed.

millisecondsTimeout est un nombre négatif différent de -1, qui représente un délai d’attente infini.millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

L’attente s’est arrêtée, car un thread s’est terminé sans libérer de mutex.The wait completed because a thread exited without releasing a mutex. Cette exception n’est pas levée sur Windows 98 ou Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

L'instance actuelle est un proxy transparent pour un WaitHandle dans un autre domaine d'application.The current instance is a transparent proxy for a WaitHandle in another application domain.

Exemples

L’exemple de code suivant montre comment utiliser un handle d’attente pour empêcher un processus de se terminer pendant qu’il attend la fin de l’exécution d’un thread d’arrière-plan.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.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

Remarques

Si millisecondsTimeout est égal à zéro, la méthode n’est pas bloquée.If millisecondsTimeout is zero, the method does not block. Il teste l’état du handle d’attente et le retourne immédiatement.It tests the state of the wait handle and returns immediately.

L’appelant de cette méthode bloque jusqu’à ce que l’instance actuelle reçoive un signal ou qu’un délai d’attente se produise.The caller of this method blocks until the current instance receives a signal or a time-out occurs. Utilisez cette méthode pour bloquer jusqu’à ce qu’un WaitHandle reçoive un signal d’un autre thread, tel que est généré lorsqu’une opération asynchrone se termine.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Pour plus d’informations, consultez l’interface IAsyncResult.For more information, see the IAsyncResult interface.

Substituez cette méthode pour personnaliser le comportement des classes dérivées.Override this method to customize the behavior of derived classes.

L’appel de cette surcharge de méthode est identique à l’appel de la surcharge WaitOne(Int32, Boolean) et à la spécification d' false pour exitContext.Calling this method overload is the same as calling the WaitOne(Int32, Boolean) overload and specifying false for exitContext.

WaitOne(TimeSpan)

Bloque le thread actuel jusqu'à ce que l'instance actuelle reçoive un signal, en utilisant une valeur TimeSpan pour spécifier l'intervalle de temps.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);
public virtual bool WaitOne (TimeSpan timeout);
abstract member WaitOne : TimeSpan -> bool
override this.WaitOne : TimeSpan -> bool
Public Overridable Function WaitOne (timeout As TimeSpan) As Boolean

Paramètres

timeout
TimeSpan

TimeSpan qui représente le nombre de millisecondes à attendre ou TimeSpan qui représente -1 milliseconde de seconde, pour attendre indéfiniment.A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

Retours

true si l'instance actuelle reçoit un signal ; sinon, false.true if the current instance receives a signal; otherwise, false.

Exceptions

L’instance actuelle a déjà été supprimée.The current instance has already been disposed.

timeout est un nombre négatif autre que -1 milliseconde, qui représente un délai d’attente infini.timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. -ou--or- timeout est supérieur à MaxValue.timeout is greater than MaxValue.

L’attente s’est arrêtée, car un thread s’est terminé sans libérer de mutex.The wait completed because a thread exited without releasing a mutex. Cette exception n’est pas levée sur Windows 98 ou Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

L'instance actuelle est un proxy transparent pour un WaitHandle dans un autre domaine d'application.The current instance is a transparent proxy for a WaitHandle in another application domain.

Remarques

Si timeout est égal à zéro, la méthode n’est pas bloquée.If timeout is zero, the method does not block. Il teste l’état du handle d’attente et le retourne immédiatement.It tests the state of the wait handle and returns immediately.

L’appelant de cette méthode bloque jusqu’à ce que l’instance actuelle reçoive un signal ou qu’un délai d’attente se produise.The caller of this method blocks until the current instance receives a signal or a time-out occurs. Utilisez cette méthode pour bloquer jusqu’à ce qu’un WaitHandle reçoive un signal d’un autre thread, tel que est généré lorsqu’une opération asynchrone se termine.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Pour plus d’informations, consultez l’interface IAsyncResult.For more information, see the IAsyncResult interface.

Substituez cette méthode pour personnaliser le comportement des classes dérivées.Override this method to customize the behavior of derived classes.

La valeur maximale de timeout est Int32.MaxValue.The maximum value for timeout is Int32.MaxValue.

L’appel de cette surcharge de méthode est identique à l’appel de la surcharge WaitOne(TimeSpan, Boolean) et à la spécification d' false pour exitContext.Calling this method overload is the same as calling the WaitOne(TimeSpan, Boolean) overload and specifying false for exitContext.

WaitOne(Int32, Boolean)

Bloque le thread actuel jusqu’à ce que le WaitHandle actuel reçoive un signal, en utilisant un entier signé 32 bits pour spécifier l’intervalle de temps et en spécifiant s’il faut quitter le domaine de synchronisation avant l’attente.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);
public virtual bool WaitOne (int millisecondsTimeout, bool exitContext);
abstract member WaitOne : int * bool -> bool
override this.WaitOne : int * bool -> bool
Public Overridable Function WaitOne (millisecondsTimeout As Integer, exitContext As Boolean) As Boolean

Paramètres

millisecondsTimeout
Int32

Nombre de millisecondes à attendre, ou Infinite (-1) pour un délai d'attente infini.The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

exitContext
Boolean

true pour quitter le domaine de synchronisation du contexte avant l'attente (dans le cas d'un contexte synchronisé) et l'acquérir à nouveau ensuite ; sinon, false.true to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

Retours

true si l'instance actuelle reçoit un signal ; sinon, false.true if the current instance receives a signal; otherwise, false.

Exceptions

L’instance actuelle a déjà été supprimée.The current instance has already been disposed.

millisecondsTimeout est un nombre négatif différent de -1, qui représente un délai d’attente infini.millisecondsTimeout is a negative number other than -1, which represents an infinite time-out.

L’attente s’est arrêtée, car un thread s’est terminé sans libérer de mutex.The wait completed because a thread exited without releasing a mutex. Cette exception n’est pas levée sur Windows 98 ou Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

L'instance actuelle est un proxy transparent pour un WaitHandle dans un autre domaine d'application.The current instance is a transparent proxy for a WaitHandle in another application domain.

Exemples

L’exemple suivant montre comment la surcharge de méthode WaitOne(Int32, Boolean) se comporte quand elle est appelée au sein d’un domaine de synchronisation.The following example shows how the WaitOne(Int32, Boolean) method overload behaves when it is called within a synchronization domain. Tout d’abord, un thread attend une exitContext définie sur false et se bloque jusqu’à l’expiration du délai d’attente.First, a thread waits with exitContext set to false and blocks until the wait timeout expires. Un deuxième thread s’exécute après que le premier thread s’est terminé et qu’il attende exitContext défini sur true.A second thread executes after the first thread terminates and waits with exitContext set to true. L’appel pour signaler le handle d’attente pour ce deuxième thread n’est pas bloqué, et le thread se termine avant le délai d’attente.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.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!!!

Remarques

Si millisecondsTimeout est égal à zéro, la méthode n’est pas bloquée.If millisecondsTimeout is zero, the method does not block. Il teste l’état du handle d’attente et le retourne immédiatement.It tests the state of the wait handle and returns immediately.

AbandonedMutexException est une nouveauté de la version 2,0 de .NET Framework.AbandonedMutexException is new in the .NET Framework version 2.0. Dans les versions précédentes, la méthode WaitOne retourne true lorsqu’un mutex est abandonné.In previous versions, the WaitOne method returns true when a mutex is abandoned. Un mutex abandonné indique souvent une erreur de codage grave.An abandoned mutex often indicates a serious coding error. Dans le cas d’un mutex à l’ensemble du système, cela peut indiquer qu’une application a été interrompue brusquement (par exemple, à l’aide du gestionnaire des tâches 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). L’exception contient des informations utiles pour le débogage.The exception contains information useful for debugging.

L’appelant de cette méthode bloque jusqu’à ce que l’instance actuelle reçoive un signal ou qu’un délai d’attente se produise.The caller of this method blocks until the current instance receives a signal or a time-out occurs. Utilisez cette méthode pour bloquer jusqu’à ce qu’un WaitHandle reçoive un signal d’un autre thread, tel que est généré lorsqu’une opération asynchrone se termine.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Pour plus d’informations, consultez l’interface IAsyncResult.For more information, see the IAsyncResult interface.

Substituez cette méthode pour personnaliser le comportement des classes dérivées.Override this method to customize the behavior of derived classes.

Remarques sur la sortie du contexteNotes on Exiting the Context

Le paramètre exitContext n’a aucun effet, à moins que la méthode WaitOne soit appelée à partir d’un contexte managé non défini par défaut.The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. Cela peut se produire si votre thread est à l’intérieur d’un appel à une instance d’une classe dérivée de ContextBoundObject.This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. Même si vous exécutez actuellement une méthode sur une classe qui ne dérive pas de ContextBoundObject, comme String, vous pouvez être dans un contexte non défini par défaut si un ContextBoundObject se trouve sur votre pile dans le domaine d’application actuel.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.

Lorsque votre code s’exécute dans un contexte non défini par défaut, la spécification de true pour exitContext amène le thread à quitter le contexte managé non défini par défaut (c’est-à-dire à passer au contexte par défaut) avant d’exécuter la méthode 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. Le thread retourne au contexte par défaut d’origine après l’appel à la méthode WaitOne.The thread returns to the original nondefault context after the call to the WaitOne method completes.

Cela peut être utile lorsque la classe liée au contexte a SynchronizationAttribute.This can be useful when the context-bound class has SynchronizationAttribute. Dans ce cas, tous les appels aux membres de la classe sont automatiquement synchronisés et le domaine de synchronisation est le corps entier du code pour la classe.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. Si le code de la pile des appels d’un membre appelle la méthode WaitOne et spécifie true pour exitContext, le thread quitte le domaine de synchronisation, ce qui permet à un thread qui est bloqué sur un appel à n’importe quel membre de l’objet de continuer.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. Quand la méthode WaitOne retourne, le thread qui a effectué l’appel doit attendre pour entrer de nouveau dans le domaine de synchronisation.When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

WaitOne(TimeSpan, Boolean)

Bloque le thread actuel jusqu'à ce que l'instance actuelle reçoive un signal, en utilisant une valeur TimeSpan pour spécifier l'intervalle de temps et en spécifiant s'il faut quitter le domaine de synchronisation avant l'attente.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);
public virtual bool WaitOne (TimeSpan timeout, bool exitContext);
abstract member WaitOne : TimeSpan * bool -> bool
override this.WaitOne : TimeSpan * bool -> bool
Public Overridable Function WaitOne (timeout As TimeSpan, exitContext As Boolean) As Boolean

Paramètres

timeout
TimeSpan

TimeSpan qui représente le nombre de millisecondes à attendre ou TimeSpan qui représente -1 milliseconde de seconde, pour attendre indéfiniment.A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

exitContext
Boolean

true pour quitter le domaine de synchronisation du contexte avant l'attente (dans le cas d'un contexte synchronisé) et l'acquérir à nouveau ensuite ; sinon, false.true to exit the synchronization domain for the context before the wait (if in a synchronized context), and reacquire it afterward; otherwise, false.

Retours

true si l'instance actuelle reçoit un signal ; sinon, false.true if the current instance receives a signal; otherwise, false.

Exceptions

L’instance actuelle a déjà été supprimée.The current instance has already been disposed.

timeout est un nombre négatif autre que -1 milliseconde, qui représente un délai d’attente infini.timeout is a negative number other than -1 milliseconds, which represents an infinite time-out. -ou--or- timeout est supérieur à MaxValue.timeout is greater than MaxValue.

L’attente s’est arrêtée, car un thread s’est terminé sans libérer de mutex.The wait completed because a thread exited without releasing a mutex. Cette exception n’est pas levée sur Windows 98 ou Windows Millennium Edition.This exception is not thrown on Windows 98 or Windows Millennium Edition.

L'instance actuelle est un proxy transparent pour un WaitHandle dans un autre domaine d'application.The current instance is a transparent proxy for a WaitHandle in another application domain.

Exemples

L’exemple de code suivant montre comment utiliser un handle d’attente pour empêcher un processus de se terminer pendant qu’il attend la fin de l’exécution d’un thread d’arrière-plan.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.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

Remarques

Si timeout est égal à zéro, la méthode n’est pas bloquée.If timeout is zero, the method does not block. Il teste l’état du handle d’attente et le retourne immédiatement.It tests the state of the wait handle and returns immediately.

AbandonedMutexException est une nouveauté de la version 2,0 de .NET Framework.AbandonedMutexException is new in the .NET Framework version 2.0. Dans les versions précédentes, la méthode WaitOne retourne true lorsqu’un mutex est abandonné.In previous versions, the WaitOne method returns true when a mutex is abandoned. Un mutex abandonné indique souvent une erreur de codage grave.An abandoned mutex often indicates a serious coding error. Dans le cas d’un mutex à l’ensemble du système, cela peut indiquer qu’une application a été interrompue brusquement (par exemple, à l’aide du gestionnaire des tâches 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). L’exception contient des informations utiles pour le débogage.The exception contains information useful for debugging.

L’appelant de cette méthode bloque jusqu’à ce que l’instance actuelle reçoive un signal ou qu’un délai d’attente se produise.The caller of this method blocks until the current instance receives a signal or a time-out occurs. Utilisez cette méthode pour bloquer jusqu’à ce qu’un WaitHandle reçoive un signal d’un autre thread, tel que est généré lorsqu’une opération asynchrone se termine.Use this method to block until a WaitHandle receives a signal from another thread, such as is generated when an asynchronous operation completes. Pour plus d’informations, consultez l’interface IAsyncResult.For more information, see the IAsyncResult interface.

Substituez cette méthode pour personnaliser le comportement des classes dérivées.Override this method to customize the behavior of derived classes.

La valeur maximale de timeout est Int32.MaxValue.The maximum value for timeout is Int32.MaxValue.

Remarques sur la sortie du contexteNotes on Exiting the Context

Le paramètre exitContext n’a aucun effet, à moins que la méthode WaitOne soit appelée à partir d’un contexte managé non défini par défaut.The exitContext parameter has no effect unless the WaitOne method is called from inside a nondefault managed context. Cela peut se produire si votre thread est à l’intérieur d’un appel à une instance d’une classe dérivée de ContextBoundObject.This can happen if your thread is inside a call to an instance of a class derived from ContextBoundObject. Même si vous exécutez actuellement une méthode sur une classe qui ne dérive pas de ContextBoundObject, comme String, vous pouvez être dans un contexte non défini par défaut si un ContextBoundObject se trouve sur votre pile dans le domaine d’application actuel.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.

Lorsque votre code s’exécute dans un contexte non défini par défaut, la spécification de true pour exitContext amène le thread à quitter le contexte managé non défini par défaut (c’est-à-dire à passer au contexte par défaut) avant d’exécuter la méthode 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. Le thread retourne au contexte par défaut d’origine après l’appel à la méthode WaitOne.The thread returns to the original nondefault context after the call to the WaitOne method completes.

Cela peut être utile lorsque la classe liée au contexte a SynchronizationAttribute.This can be useful when the context-bound class has SynchronizationAttribute. Dans ce cas, tous les appels aux membres de la classe sont automatiquement synchronisés et le domaine de synchronisation est le corps entier du code pour la classe.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. Si le code de la pile des appels d’un membre appelle la méthode WaitOne et spécifie true pour exitContext, le thread quitte le domaine de synchronisation, ce qui permet à un thread qui est bloqué sur un appel à n’importe quel membre de l’objet de continuer.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. Quand la méthode WaitOne retourne, le thread qui a effectué l’appel doit attendre pour entrer de nouveau dans le domaine de synchronisation.When the WaitOne method returns, the thread that made the call must wait to reenter the synchronization domain.

S’applique à