ThreadPool.RegisterWaitForSingleObject Méthode

Définition

Inscrit un délégué en attente de WaitHandle.Registers a delegate that is waiting for a WaitHandle.

Surcharges

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, UInt32, Boolean)

Inscrit un délégué pour attendre un WaitHandle, en utilisant, pour indiquer le délai en millisecondes, un entier 32 bits non signé.Registers a delegate to wait for a WaitHandle, specifying a 32-bit unsigned integer for the time-out in milliseconds.

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, TimeSpan, Boolean)

Inscrit un délégué en attente de WaitHandle, en spécifiant une valeur TimeSpan pour indiquer le délai.Registers a delegate to wait for a WaitHandle, specifying a TimeSpan value for the time-out.

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int32, Boolean)

Inscrit un délégué pour attendre un WaitHandle, en utilisant, pour indiquer le délai en millisecondes, un entier 32 bits signé.Registers a delegate to wait for a WaitHandle, specifying a 32-bit signed integer for the time-out in milliseconds.

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int64, Boolean)

Inscrit un délégué pour attendre un WaitHandle, en utilisant, pour indiquer le délai en millisecondes, un entier 64 bits signé.Registers a delegate to wait for a WaitHandle, specifying a 64-bit signed integer for the time-out in milliseconds.

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, UInt32, Boolean)

Important

Cette API n’est pas conforme CLS.

Inscrit un délégué pour attendre un WaitHandle, en utilisant, pour indiquer le délai en millisecondes, un entier 32 bits non signé.Registers a delegate to wait for a WaitHandle, specifying a 32-bit unsigned integer for the time-out in milliseconds.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, System::UInt32 millisecondsTimeOutInterval, bool executeOnlyOnce);
[System.CLSCompliant(false)]
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, uint millisecondsTimeOutInterval, bool executeOnlyOnce);
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * uint32 * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As UInteger, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Paramètres

waitObject
WaitHandle

WaitHandle à inscrire.The WaitHandle to register. Utilisez un WaitHandle autre que Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Délégué WaitOrTimerCallback à appeler lorsque le paramètre waitObject est signalé.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Objet passé au délégué.The object passed to the delegate.

millisecondsTimeOutInterval
UInt32

Délai en millisecondes.The time-out in milliseconds. Si le paramètre millisecondsTimeOutInterval a la valeur zéro (0), la fonction teste l'état de l'objet et procède à un retour immédiat.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Si millisecondsTimeOutInterval a la valeur -1, le délai d'expiration de la fonction ne prend jamais fin.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

true pour indiquer que le thread ne tiendra plus compte du paramètre waitObject une fois le délégué appelé ; false pour indiquer que la minuterie sera réinitialisée à chaque achèvement d'opération d'attente, jusqu'à annulation de l'inscription de l'attente.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Retours

RegisteredWaitHandle pouvant être utilisé pour annuler l'opération d'attente inscrite.The RegisteredWaitHandle that can be used to cancel the registered wait operation.

Attributs

Exceptions

Le paramètre millisecondsTimeOutInterval est inférieur à -1.The millisecondsTimeOutInterval parameter is less than -1.

Exemples

L’exemple suivant montre comment utiliser la méthode RegisterWaitForSingleObject pour exécuter une méthode de rappel spécifiée lorsqu’un handle d’attente spécifié est signalé.The following example shows how to use the RegisterWaitForSingleObject method to execute a specified callback method when a specified wait handle is signaled. Dans cet exemple, la méthode de rappel est WaitProc, et le handle d’attente est un AutoResetEvent.In this example, the callback method is WaitProc, and the wait handle is an AutoResetEvent.

L’exemple définit une classe TaskInfo pour stocker les informations passées au rappel lorsqu’il s’exécute.The example defines a TaskInfo class to hold the information that is passed to the callback when it executes. L’exemple crée un objet TaskInfo et lui attribue des données de type chaîne.The example creates a TaskInfo object and assigns it some string data. La RegisteredWaitHandle qui est retournée par la méthode RegisterWaitForSingleObject est assignée au champ Handle de l’objet TaskInfo afin que la méthode de rappel ait accès au RegisteredWaitHandle.The RegisteredWaitHandle that is returned by the RegisterWaitForSingleObject method is assigned to the Handle field of the TaskInfo object so that the callback method has access to the RegisteredWaitHandle.

En plus de spécifier TaskInfo comme objet à passer à la méthode de rappel, l’appel à la méthode RegisterWaitForSingleObject spécifie le AutoResetEvent que la tâche attendra, un délégué WaitOrTimerCallback qui représente la méthode de rappel WaitProc, un intervalle de délai d’attente d’un seconde et plusieurs rappels.In addition to specifying TaskInfo as the object to pass to the callback method, the call to the RegisterWaitForSingleObject method specifies the AutoResetEvent that the task will wait for, a WaitOrTimerCallback delegate that represents the WaitProc callback method, a one second time-out interval, and multiple callbacks.

Lorsque le thread principal signale le AutoResetEvent en appelant sa méthode Set, le délégué WaitOrTimerCallback est appelé.When the main thread signals the AutoResetEvent by calling its Set method, the WaitOrTimerCallback delegate is invoked. La méthode WaitProc teste RegisteredWaitHandle pour déterminer si un délai d’attente a été dépassé.The WaitProc method tests RegisteredWaitHandle to determine whether a time-out occurred. Si le rappel a été appelé parce que le handle d’attente a été signalé, la méthode WaitProc annule l’inscription du RegisteredWaitHandle, en arrêtant les rappels supplémentaires.If the callback was invoked because the wait handle was signaled, the WaitProc method unregisters the RegisteredWaitHandle, stopping additional callbacks. Dans le cas d’un délai d’attente, la tâche continue à attendre.In the case of a time-out, the task continues to wait. La méthode WaitProc se termine en imprimant un message sur la console.The WaitProc method ends by printing a message to the console.

using namespace System;
using namespace System::Threading;

// TaskInfo contains data that will be passed to the callback
// method.
public ref class TaskInfo
{
public:
   TaskInfo()
   {
      Handle = nullptr;
      OtherInfo = "default";
   }

   RegisteredWaitHandle^ Handle;
   String^ OtherInfo;
};

ref class Example
{
public:

   // The callback method executes when the registered wait times out,
   // or when the WaitHandle (in this case AutoResetEvent) is signaled.
   // WaitProc unregisters the WaitHandle the first time the event is 
   // signaled.
   static void WaitProc( Object^ state, bool timedOut )
   {
      
      // The state Object must be cast to the correct type, because the
      // signature of the WaitOrTimerCallback delegate specifies type
      // Object.
      TaskInfo^ ti = static_cast<TaskInfo^>(state);
      String^ cause = "TIMED OUT";
      if (  !timedOut )
      {
         cause = "SIGNALED";
         
         // If the callback method executes because the WaitHandle is
         // signaled, stop future execution of the callback method
         // by unregistering the WaitHandle.
         if ( ti->Handle != nullptr )
                  ti->Handle->Unregister( nullptr );
      }

      Console::WriteLine( "WaitProc( {0}) executes on thread {1}; cause = {2}.", ti->OtherInfo, Thread::CurrentThread->GetHashCode(), cause );
   }

};

int main()
{
   
   // The main thread uses AutoResetEvent to signal the
   // registered wait handle, which executes the callback
   // method.
   AutoResetEvent^ ev = gcnew AutoResetEvent( false );
   TaskInfo^ ti = gcnew TaskInfo;
   ti->OtherInfo = "First task";
   
   // The TaskInfo for the task includes the registered wait
   // handle returned by RegisterWaitForSingleObject.  This
   // allows the wait to be terminated when the object has
   // been signaled once (see WaitProc).
   ti->Handle = ThreadPool::RegisterWaitForSingleObject( ev, gcnew WaitOrTimerCallback( Example::WaitProc ), ti, 1000, false );
   
   // The main thread waits three seconds, to demonstrate the
   // time-outs on the queued thread, and then signals.
   Thread::Sleep( 3100 );
   Console::WriteLine( "Main thread signals." );
   ev->Set();
   
   // The main thread sleeps, which should give the callback
   // method time to execute.  If you comment out this line, the
   // program usually ends before the ThreadPool thread can execute.
   Thread::Sleep( 1000 );
   
   // If you start a thread yourself, you can wait for it to end
   // by calling Thread::Join.  This option is not available with 
   // thread pool threads.
   return 0;
}

using System;
using System.Threading;

// TaskInfo contains data that will be passed to the callback
// method.
public class TaskInfo {
    public RegisteredWaitHandle Handle = null;
    public string OtherInfo = "default";
}

public class Example {
    public static void Main(string[] args) {
        // The main thread uses AutoResetEvent to signal the
        // registered wait handle, which executes the callback
        // method.
        AutoResetEvent ev = new AutoResetEvent(false);

        TaskInfo ti = new TaskInfo();
        ti.OtherInfo = "First task";
        // The TaskInfo for the task includes the registered wait
        // handle returned by RegisterWaitForSingleObject.  This
        // allows the wait to be terminated when the object has
        // been signaled once (see WaitProc).
        ti.Handle = ThreadPool.RegisterWaitForSingleObject(
            ev,
            new WaitOrTimerCallback(WaitProc),
            ti,
            1000,
            false
        );

        // The main thread waits three seconds, to demonstrate the
        // time-outs on the queued thread, and then signals.
        Thread.Sleep(3100);
        Console.WriteLine("Main thread signals.");
        ev.Set();

        // The main thread sleeps, which should give the callback
        // method time to execute.  If you comment out this line, the
        // program usually ends before the ThreadPool thread can execute.
        Thread.Sleep(1000);
        // If you start a thread yourself, you can wait for it to end
        // by calling Thread.Join.  This option is not available with 
        // thread pool threads.
    }
   
    // The callback method executes when the registered wait times out,
    // or when the WaitHandle (in this case AutoResetEvent) is signaled.
    // WaitProc unregisters the WaitHandle the first time the event is 
    // signaled.
    public static void WaitProc(object state, bool timedOut) {
        // The state object must be cast to the correct type, because the
        // signature of the WaitOrTimerCallback delegate specifies type
        // Object.
        TaskInfo ti = (TaskInfo) state;

        string cause = "TIMED OUT";
        if (!timedOut) {
            cause = "SIGNALED";
            // If the callback method executes because the WaitHandle is
            // signaled, stop future execution of the callback method
            // by unregistering the WaitHandle.
            if (ti.Handle != null)
                ti.Handle.Unregister(null);
        } 

        Console.WriteLine("WaitProc( {0} ) executes on thread {1}; cause = {2}.",
            ti.OtherInfo, 
            Thread.CurrentThread.GetHashCode().ToString(), 
            cause
        );
    }
}
Imports System.Threading

' TaskInfo contains data that will be passed to the callback
' method.
Public Class TaskInfo
    public Handle As RegisteredWaitHandle = Nothing
    public OtherInfo As String = "default"
End Class

Public Class Example

    <MTAThread> _
    Public Shared Sub Main()
        ' The main thread uses AutoResetEvent to signal the
        ' registered wait handle, which executes the callback
        ' method.
        Dim ev As New AutoResetEvent(false)

        Dim ti As New TaskInfo()
        ti.OtherInfo = "First task"
        ' The TaskInfo for the task includes the registered wait
        ' handle returned by RegisterWaitForSingleObject.  This
        ' allows the wait to be terminated when the object has
        ' been signaled once (see WaitProc).
        ti.Handle = ThreadPool.RegisterWaitForSingleObject( _
            ev, _
            New WaitOrTimerCallback(AddressOf WaitProc), _
            ti, _
            1000, _
            false _
        )

        ' The main thread waits about three seconds, to demonstrate 
        ' the time-outs on the queued task, and then signals.
        Thread.Sleep(3100)
        Console.WriteLine("Main thread signals.")
        ev.Set()

        ' The main thread sleeps, which should give the callback
        ' method time to execute.  If you comment out this line, the
        ' program usually ends before the ThreadPool thread can execute.
        Thread.Sleep(1000)
        ' If you start a thread yourself, you can wait for it to end
        ' by calling Thread.Join.  This option is not available with 
        ' thread pool threads.
    End Sub
   
    ' The callback method executes when the registered wait times out,
    ' or when the WaitHandle (in this case AutoResetEvent) is signaled.
    ' WaitProc unregisters the WaitHandle the first time the event is 
    ' signaled.
    Public Shared Sub WaitProc(state As Object, timedOut As Boolean)
        ' The state object must be cast to the correct type, because the
        ' signature of the WaitOrTimerCallback delegate specifies type
        ' Object.
        Dim ti As TaskInfo = CType(state, TaskInfo)

        Dim cause As String = "TIMED OUT"
        If Not timedOut Then
            cause = "SIGNALED"
            ' If the callback method executes because the WaitHandle is
            ' signaled, stop future execution of the callback method
            ' by unregistering the WaitHandle.
            If Not ti.Handle Is Nothing Then
                ti.Handle.Unregister(Nothing)
            End If
        End If 

        Console.WriteLine("WaitProc( {0} ) executes on thread {1}; cause = {2}.", _
            ti.OtherInfo, _
            Thread.CurrentThread.GetHashCode().ToString(), _
            cause _
        )
    End Sub
End Class

Remarques

Lorsque vous avez terminé d’utiliser la RegisteredWaitHandle qui est retournée par cette méthode, appelez sa méthode RegisteredWaitHandle.Unregister pour libérer les références au handle d’attente.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Nous vous recommandons de toujours appeler la méthode RegisteredWaitHandle.Unregister, même si vous spécifiez true pour executeOnlyOnce.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Le garbage collection fonctionne plus efficacement si vous appelez la méthode RegisteredWaitHandle.Unregister au lieu de dépendre du finaliseur du handle d’attente inscrit.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

La méthode RegisterWaitForSingleObject met le délégué spécifié en file d’attente dans le pool de threads.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un thread de travail exécute le délégué lorsque l’un des éléments suivants se produit :A worker thread will execute the delegate when one of the following occurs:

  • L’objet spécifié est dans l’état signalé.The specified object is in the signaled state.

  • L’intervalle de délai d’attente est écoulé.The time-out interval elapses.

La méthode RegisterWaitForSingleObject vérifie l’état actuel de la WaitHandle de l’objet spécifié.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Si l’état de l’objet est non signalé, la méthode enregistre une opération d’attente.If the object's state is unsignaled, the method registers a wait operation. L’opération d’attente est effectuée par un thread à partir du pool de threads.The wait operation is performed by a thread from the thread pool. Le délégué est exécuté par un thread de travail lorsque l’état de l’objet est signalé ou lorsque l’intervalle de délai d’attente est écoulé.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Si le paramètre timeOutInterval n’a pas la valeur 0 (zéro) et que le paramètre executeOnlyOnce est false, le minuteur est réinitialisé chaque fois que l’événement est signalé ou que l’intervalle de délai d’attente est écoulé.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Important

L’utilisation d’un Mutex pour waitObject ne fournit pas d’exclusion mutuelle pour les rappels, car l’API Windows sous-jacente utilise l’indicateur WT_EXECUTEDEFAULT par défaut, de sorte que chaque rappel est distribué sur un thread de pool de threads distinct.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. Au lieu d’un Mutex, utilisez un Semaphore avec un nombre maximal de 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Pour annuler l’opération d’attente, appelez la méthode RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Le thread d’attente utilise la fonction Win32 WaitForMultipleObjects pour surveiller les opérations d’attente inscrites.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Par conséquent, si vous devez utiliser le même handle de système d’exploitation natif dans plusieurs appels à RegisterWaitForSingleObject, vous devez dupliquer le handle à l’aide de la fonction Win32 DuplicateHandle.Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Notez que vous ne devez pas pulser un objet d’événement passé à RegisterWaitForSingleObject, car le thread d’attente peut ne pas détecter que l’événement est signalé avant sa réinitialisation.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Avant de retourner, la fonction modifie l’état de certains types d’objets de synchronisation.Before returning, the function modifies the state of some types of synchronization objects. La modification se produit uniquement pour l’objet dont l’état signalé a provoqué la satisfaction de la condition d’attente.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Par exemple, le nombre d’un sémaphore est réduit d’une unité.For example, the count of a semaphore is decreased by one.

Informations sur la versionVersion Information

À partir de la version de .NET Framework 2,0, la valeur de la propriété Thread.CurrentPrincipal est propagée aux threads de travail mis en file d’attente à l’aide de la méthode RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. Dans les versions antérieures, les informations de principal ne sont pas propagées.In earlier versions, the principal information is not propagated.

Voir aussi

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, TimeSpan, Boolean)

Inscrit un délégué en attente de WaitHandle, en spécifiant une valeur TimeSpan pour indiquer le délai.Registers a delegate to wait for a WaitHandle, specifying a TimeSpan value for the time-out.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, TimeSpan timeout, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, TimeSpan timeout, bool executeOnlyOnce);
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * TimeSpan * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, timeout As TimeSpan, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Paramètres

waitObject
WaitHandle

WaitHandle à inscrire.The WaitHandle to register. Utilisez un WaitHandle autre que Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Délégué WaitOrTimerCallback à appeler lorsque le paramètre waitObject est signalé.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Objet passé au délégué.The object passed to the delegate.

timeout
TimeSpan

Délai représenté par TimeSpan.The time-out represented by a TimeSpan. Si le paramètre timeout a la valeur zéro, la fonction teste l'état de l'objet et procède à un retour immédiat.If timeout is 0 (zero), the function tests the object's state and returns immediately. Si timeout a la valeur -1, le délai d'expiration de la fonction ne prend jamais fin.If timeout is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

true pour indiquer que le thread ne tiendra plus compte du paramètre waitObject une fois le délégué appelé ; false pour indiquer que la minuterie sera réinitialisée à chaque achèvement d'opération d'attente, jusqu'à annulation de l'inscription de l'attente.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Retours

RegisteredWaitHandle qui encapsule le handle natif.The RegisteredWaitHandle that encapsulates the native handle.

Exceptions

Le paramètre timeout est inférieur à -1.The timeout parameter is less than -1.

Le paramètre timeout est supérieur à MaxValue.The timeout parameter is greater than MaxValue.

Remarques

Lorsque vous avez terminé d’utiliser la RegisteredWaitHandle qui est retournée par cette méthode, appelez sa méthode RegisteredWaitHandle.Unregister pour libérer les références au handle d’attente.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Nous vous recommandons de toujours appeler la méthode RegisteredWaitHandle.Unregister, même si vous spécifiez true pour executeOnlyOnce.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Le garbage collection fonctionne plus efficacement si vous appelez la méthode RegisteredWaitHandle.Unregister au lieu de dépendre du finaliseur du handle d’attente inscrit.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

La méthode RegisterWaitForSingleObject met le délégué spécifié en file d’attente dans le pool de threads.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un thread de travail exécute le délégué lorsque l’un des éléments suivants se produit :A worker thread will execute the delegate when one of the following occurs:

  • L’objet spécifié est dans l’état signalé.The specified object is in the signaled state.

  • L’intervalle de délai d’attente est écoulé.The time-out interval elapses.

La méthode RegisterWaitForSingleObject vérifie l’état actuel de la WaitHandle de l’objet spécifié.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Si l’état de l’objet est non signalé, la méthode enregistre une opération d’attente.If the object's state is unsignaled, the method registers a wait operation. L’opération d’attente est effectuée par un thread à partir du pool de threads.The wait operation is performed by a thread from the thread pool. Le délégué est exécuté par un thread de travail lorsque l’état de l’objet est signalé ou lorsque l’intervalle de délai d’attente est écoulé.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Si le paramètre timeOutInterval n’a pas la valeur 0 (zéro) et que le paramètre executeOnlyOnce est false, le minuteur est réinitialisé chaque fois que l’événement est signalé ou que l’intervalle de délai d’attente est écoulé.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Important

L’utilisation d’un Mutex pour waitObject ne fournit pas d’exclusion mutuelle pour les rappels, car l’API Windows sous-jacente utilise l’indicateur WT_EXECUTEDEFAULT par défaut, de sorte que chaque rappel est distribué sur un thread de pool de threads distinct.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. Au lieu d’un Mutex, utilisez un Semaphore avec un nombre maximal de 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Pour annuler l’opération d’attente, appelez la méthode RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Le thread d’attente utilise la fonction Win32 WaitForMultipleObjects pour surveiller les opérations d’attente inscrites.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Par conséquent, si vous devez utiliser le même handle de système d’exploitation natif dans plusieurs appels à RegisterWaitForSingleObject, vous devez dupliquer le handle à l’aide de la fonction Win32 DuplicateHandle.Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Notez que vous ne devez pas pulser un objet d’événement passé à RegisterWaitForSingleObject, car le thread d’attente peut ne pas détecter que l’événement est signalé avant sa réinitialisation.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Avant de retourner, la fonction modifie l’état de certains types d’objets de synchronisation.Before returning, the function modifies the state of some types of synchronization objects. La modification se produit uniquement pour l’objet dont l’état signalé a provoqué la satisfaction de la condition d’attente.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Par exemple, le nombre d’un sémaphore est réduit d’une unité.For example, the count of a semaphore is decreased by one.

Informations sur la versionVersion Information

À partir de la version de .NET Framework 2,0, la valeur de la propriété Thread.CurrentPrincipal est propagée aux threads de travail mis en file d’attente à l’aide de la méthode RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. Dans les versions antérieures, les informations de principal ne sont pas propagées.In earlier versions, the principal information is not propagated.

Voir aussi

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int32, Boolean)

Inscrit un délégué pour attendre un WaitHandle, en utilisant, pour indiquer le délai en millisecondes, un entier 32 bits signé.Registers a delegate to wait for a WaitHandle, specifying a 32-bit signed integer for the time-out in milliseconds.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, int millisecondsTimeOutInterval, bool executeOnlyOnce);
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As Integer, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Paramètres

waitObject
WaitHandle

WaitHandle à inscrire.The WaitHandle to register. Utilisez un WaitHandle autre que Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Délégué WaitOrTimerCallback à appeler lorsque le paramètre waitObject est signalé.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Objet passé au délégué.The object that is passed to the delegate.

millisecondsTimeOutInterval
Int32

Délai en millisecondes.The time-out in milliseconds. Si le paramètre millisecondsTimeOutInterval a la valeur zéro (0), la fonction teste l'état de l'objet et procède à un retour immédiat.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Si millisecondsTimeOutInterval a la valeur -1, le délai d'expiration de la fonction ne prend jamais fin.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

true pour indiquer que le thread ne tiendra plus compte du paramètre waitObject une fois le délégué appelé ; false pour indiquer que la minuterie sera réinitialisée à chaque achèvement d'opération d'attente, jusqu'à annulation de l'inscription de l'attente.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Retours

RegisteredWaitHandle qui encapsule le handle natif.The RegisteredWaitHandle that encapsulates the native handle.

Exceptions

Le paramètre millisecondsTimeOutInterval est inférieur à -1.The millisecondsTimeOutInterval parameter is less than -1.

Remarques

Lorsque vous avez terminé d’utiliser la RegisteredWaitHandle qui est retournée par cette méthode, appelez sa méthode RegisteredWaitHandle.Unregister pour libérer les références au handle d’attente.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Nous vous recommandons de toujours appeler la méthode RegisteredWaitHandle.Unregister, même si vous spécifiez true pour executeOnlyOnce.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Le garbage collection fonctionne plus efficacement si vous appelez la méthode RegisteredWaitHandle.Unregister au lieu de dépendre du finaliseur du handle d’attente inscrit.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

La méthode RegisterWaitForSingleObject met le délégué spécifié en file d’attente dans le pool de threads.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un thread de travail exécute le délégué lorsque l’un des éléments suivants se produit :A worker thread will execute the delegate when one of the following occurs:

  • L’objet spécifié est dans l’état signalé.The specified object is in the signaled state.

  • L’intervalle de délai d’attente est écoulé.The time-out interval elapses.

La méthode RegisterWaitForSingleObject vérifie l’état actuel de la WaitHandle de l’objet spécifié.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Si l’état de l’objet est non signalé, la méthode enregistre une opération d’attente.If the object's state is unsignaled, the method registers a wait operation. L’opération d’attente est effectuée par un thread à partir du pool de threads.The wait operation is performed by a thread from the thread pool. Le délégué est exécuté par un thread de travail lorsque l’état de l’objet est signalé ou lorsque l’intervalle de délai d’attente est écoulé.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Si le paramètre timeOutInterval n’a pas la valeur 0 (zéro) et que le paramètre executeOnlyOnce est false, le minuteur est réinitialisé chaque fois que l’événement est signalé ou que l’intervalle de délai d’attente est écoulé.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Important

L’utilisation d’un Mutex pour waitObject ne fournit pas d’exclusion mutuelle pour les rappels, car l’API Windows sous-jacente utilise l’indicateur WT_EXECUTEDEFAULT par défaut, de sorte que chaque rappel est distribué sur un thread de pool de threads distinct.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. Au lieu d’un Mutex, utilisez un Semaphore avec un nombre maximal de 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Pour annuler l’opération d’attente, appelez la méthode RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Le thread d’attente utilise la fonction Win32 WaitForMultipleObjects pour surveiller les opérations d’attente inscrites.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Par conséquent, si vous devez utiliser le même handle de système d’exploitation natif dans plusieurs appels à RegisterWaitForSingleObject, vous devez dupliquer le handle à l’aide de la fonction Win32 DuplicateHandle.Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Notez que vous ne devez pas pulser un objet d’événement passé à RegisterWaitForSingleObject, car le thread d’attente peut ne pas détecter que l’événement est signalé avant sa réinitialisation.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Avant de retourner, la fonction modifie l’état de certains types d’objets de synchronisation.Before returning, the function modifies the state of some types of synchronization objects. La modification se produit uniquement pour l’objet dont l’état signalé a provoqué la satisfaction de la condition d’attente.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Par exemple, le nombre d’un sémaphore est réduit d’une unité.For example, the count of a semaphore is decreased by one.

Informations sur la versionVersion Information

À partir de la version de .NET Framework 2,0, la valeur de la propriété Thread.CurrentPrincipal est propagée aux threads de travail mis en file d’attente à l’aide de la méthode RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. Dans les versions antérieures, les informations de principal ne sont pas propagées.In earlier versions, the principal information is not propagated.

Voir aussi

RegisterWaitForSingleObject(WaitHandle, WaitOrTimerCallback, Object, Int64, Boolean)

Inscrit un délégué pour attendre un WaitHandle, en utilisant, pour indiquer le délai en millisecondes, un entier 64 bits signé.Registers a delegate to wait for a WaitHandle, specifying a 64-bit signed integer for the time-out in milliseconds.

public:
 static System::Threading::RegisteredWaitHandle ^ RegisterWaitForSingleObject(System::Threading::WaitHandle ^ waitObject, System::Threading::WaitOrTimerCallback ^ callBack, System::Object ^ state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
public static System.Threading.RegisteredWaitHandle RegisterWaitForSingleObject (System.Threading.WaitHandle waitObject, System.Threading.WaitOrTimerCallback callBack, object state, long millisecondsTimeOutInterval, bool executeOnlyOnce);
static member RegisterWaitForSingleObject : System.Threading.WaitHandle * System.Threading.WaitOrTimerCallback * obj * int64 * bool -> System.Threading.RegisteredWaitHandle
Public Shared Function RegisterWaitForSingleObject (waitObject As WaitHandle, callBack As WaitOrTimerCallback, state As Object, millisecondsTimeOutInterval As Long, executeOnlyOnce As Boolean) As RegisteredWaitHandle

Paramètres

waitObject
WaitHandle

WaitHandle à inscrire.The WaitHandle to register. Utilisez un WaitHandle autre que Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Délégué WaitOrTimerCallback à appeler lorsque le paramètre waitObject est signalé.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Objet passé au délégué.The object passed to the delegate.

millisecondsTimeOutInterval
Int64

Délai en millisecondes.The time-out in milliseconds. Si le paramètre millisecondsTimeOutInterval a la valeur zéro (0), la fonction teste l'état de l'objet et procède à un retour immédiat.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Si millisecondsTimeOutInterval a la valeur -1, le délai d'expiration de la fonction ne prend jamais fin.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

true pour indiquer que le thread ne tiendra plus compte du paramètre waitObject une fois le délégué appelé ; false pour indiquer que la minuterie sera réinitialisée à chaque achèvement d'opération d'attente, jusqu'à annulation de l'inscription de l'attente.true to indicate that the thread will no longer wait on the waitObject parameter after the delegate has been called; false to indicate that the timer is reset every time the wait operation completes until the wait is unregistered.

Retours

RegisteredWaitHandle qui encapsule le handle natif.The RegisteredWaitHandle that encapsulates the native handle.

Exceptions

Le paramètre millisecondsTimeOutInterval est inférieur à -1.The millisecondsTimeOutInterval parameter is less than -1.

Remarques

Lorsque vous avez terminé d’utiliser la RegisteredWaitHandle qui est retournée par cette méthode, appelez sa méthode RegisteredWaitHandle.Unregister pour libérer les références au handle d’attente.When you are finished using the RegisteredWaitHandle that is returned by this method, call its RegisteredWaitHandle.Unregister method to release references to the wait handle. Nous vous recommandons de toujours appeler la méthode RegisteredWaitHandle.Unregister, même si vous spécifiez true pour executeOnlyOnce.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Le garbage collection fonctionne plus efficacement si vous appelez la méthode RegisteredWaitHandle.Unregister au lieu de dépendre du finaliseur du handle d’attente inscrit.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

La méthode RegisterWaitForSingleObject met le délégué spécifié en file d’attente dans le pool de threads.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un thread de travail exécute le délégué lorsque l’un des éléments suivants se produit :A worker thread will execute the delegate when one of the following occurs:

  • L’objet spécifié est dans l’état signalé.The specified object is in the signaled state.

  • L’intervalle de délai d’attente est écoulé.The time-out interval elapses.

La méthode RegisterWaitForSingleObject vérifie l’état actuel de la WaitHandle de l’objet spécifié.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Si l’état de l’objet est non signalé, la méthode enregistre une opération d’attente.If the object's state is unsignaled, the method registers a wait operation. L’opération d’attente est effectuée par un thread à partir du pool de threads.The wait operation is performed by a thread from the thread pool. Le délégué est exécuté par un thread de travail lorsque l’état de l’objet est signalé ou lorsque l’intervalle de délai d’attente est écoulé.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Si le paramètre timeOutInterval n’a pas la valeur 0 (zéro) et que le paramètre executeOnlyOnce est false, le minuteur est réinitialisé chaque fois que l’événement est signalé ou que l’intervalle de délai d’attente est écoulé.If the timeOutInterval parameter is not 0 (zero) and the executeOnlyOnce parameter is false, the timer is reset every time the event is signaled or the time-out interval elapses.

Important

L’utilisation d’un Mutex pour waitObject ne fournit pas d’exclusion mutuelle pour les rappels, car l’API Windows sous-jacente utilise l’indicateur WT_EXECUTEDEFAULT par défaut, de sorte que chaque rappel est distribué sur un thread de pool de threads distinct.Using a Mutex for waitObject does not provide mutual exclusion for the callbacks because the underlying Windows API uses the default WT_EXECUTEDEFAULT flag, so each callback is dispatched on a separate thread pool thread. Au lieu d’un Mutex, utilisez un Semaphore avec un nombre maximal de 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Pour annuler l’opération d’attente, appelez la méthode RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Le thread d’attente utilise la fonction Win32 WaitForMultipleObjects pour surveiller les opérations d’attente inscrites.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Par conséquent, si vous devez utiliser le même handle de système d’exploitation natif dans plusieurs appels à RegisterWaitForSingleObject, vous devez dupliquer le handle à l’aide de la fonction Win32 DuplicateHandle.Therefore, if you must use the same native operating system handle in multiple calls to RegisterWaitForSingleObject, you must duplicate the handle using the Win32 DuplicateHandle function. Notez que vous ne devez pas pulser un objet d’événement passé à RegisterWaitForSingleObject, car le thread d’attente peut ne pas détecter que l’événement est signalé avant sa réinitialisation.Note that you should not pulse an event object passed to RegisterWaitForSingleObject, because the wait thread might not detect that the event is signaled before it is reset.

Avant de retourner, la fonction modifie l’état de certains types d’objets de synchronisation.Before returning, the function modifies the state of some types of synchronization objects. La modification se produit uniquement pour l’objet dont l’état signalé a provoqué la satisfaction de la condition d’attente.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Par exemple, le nombre d’un sémaphore est réduit d’une unité.For example, the count of a semaphore is decreased by one.

Informations sur la versionVersion Information

À partir de la version de .NET Framework 2,0, la valeur de la propriété Thread.CurrentPrincipal est propagée aux threads de travail mis en file d’attente à l’aide de la méthode RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. Dans les versions antérieures, les informations de principal ne sont pas propagées.In earlier versions, the principal information is not propagated.

Voir aussi

S’applique à