ThreadPool.RegisterWaitForSingleObject Metodo

Definizione

Registra un delegato in attesa di un WaitHandle.Registers a delegate that is waiting for a WaitHandle.

Overload

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

Registra un delegato per l'attesa di un oggetto WaitHandle, specificando un intero senza segno a 32 bit per il timeout in millisecondi.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)

Registra un delegato per l'attesa di un oggetto WaitHandle, specificando un valore TimeSpan per il timeout.Registers a delegate to wait for a WaitHandle, specifying a TimeSpan value for the time-out.

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

Registra un delegato per l'attesa di un oggetto WaitHandle, specificando un valore intero con segno a 32 bit per il timeout in millisecondi.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)

Registra un delegato per l'attesa di un oggetto WaitHandle, specificando un valore intero con segno a 64 bit per il timeout in millisecondi.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)

Importante

Questa API non è conforme a CLS.

Registra un delegato per l'attesa di un oggetto WaitHandle, specificando un intero senza segno a 32 bit per il timeout in millisecondi.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

Parametri

waitObject
WaitHandle

WaitHandle da registrare.The WaitHandle to register. Usare una classe WaitHandle diversa da Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Delegato WaitOrTimerCallback da chiamare quando il parametro waitObject riceve un segnale.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Oggetto passato al delegato.The object passed to the delegate.

millisecondsTimeOutInterval
UInt32

Timeout in millisecondi.The time-out in milliseconds. Se il parametro millisecondsTimeOutInterval è pari a 0 (zero), la funzione verifica lo stato dell'oggetto e restituisce immediatamente un valore.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Se millisecondsTimeOutInterval è -1, l'intervallo di timeout della funzione non termina mai.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Viene restituito true per indicare che il thread non attenderà più in base al parametro waitObject dopo la chiamata al delegato; false per indicare che il timer viene reimpostato ogni volta che l'operazione di attesa viene completata fino all'annullamento della registrazione dell'attesa.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.

Restituisce

Oggetto RegisteredWaitHandle che può essere usato per annullare l'operazione di attesa registrata.The RegisteredWaitHandle that can be used to cancel the registered wait operation.

Attributi

Eccezioni

Il parametro millisecondsTimeOutInterval è minore di -1.The millisecondsTimeOutInterval parameter is less than -1.

Esempi

Nell'esempio seguente viene illustrato come utilizzare il metodo RegisterWaitForSingleObject per eseguire un metodo di callback specificato quando viene segnalato un handle di attesa specificato.The following example shows how to use the RegisterWaitForSingleObject method to execute a specified callback method when a specified wait handle is signaled. In questo esempio, il metodo di callback è WaitProce l'handle di attesa è un AutoResetEvent.In this example, the callback method is WaitProc, and the wait handle is an AutoResetEvent.

Nell'esempio viene definita una classe TaskInfo per conservare le informazioni che vengono passate al callback quando viene eseguita.The example defines a TaskInfo class to hold the information that is passed to the callback when it executes. Nell'esempio viene creato un oggetto TaskInfo e vengono assegnati alcuni dati di stringa.The example creates a TaskInfo object and assigns it some string data. Il RegisteredWaitHandle restituito dal metodo RegisterWaitForSingleObject viene assegnato al campo Handle dell'oggetto TaskInfo in modo che il metodo di callback abbia accesso al 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.

Oltre a specificare TaskInfo come oggetto da passare al metodo di callback, la chiamata al metodo RegisterWaitForSingleObject specifica il AutoResetEvent che l'attività resterà in attesa, un delegato WaitOrTimerCallback che rappresenta il metodo di callback WaitProc, un intervallo di timeout di un secondo e più callback.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.

Quando il thread principale segnala il AutoResetEvent chiamando il relativo metodo Set, viene richiamato il delegato WaitOrTimerCallback.When the main thread signals the AutoResetEvent by calling its Set method, the WaitOrTimerCallback delegate is invoked. Il metodo WaitProc verifica RegisteredWaitHandle per determinare se si è verificato un timeout.The WaitProc method tests RegisteredWaitHandle to determine whether a time-out occurred. Se il callback è stato richiamato perché l'handle di attesa è stato segnalato, il metodo WaitProc Annulla la registrazione del RegisteredWaitHandle, arrestando i callback aggiuntivi.If the callback was invoked because the wait handle was signaled, the WaitProc method unregisters the RegisteredWaitHandle, stopping additional callbacks. Nel caso di un timeout, l'attività continua ad attendere.In the case of a time-out, the task continues to wait. Il metodo WaitProc termina stampando un messaggio nella 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

Commenti

Al termine dell'utilizzo del RegisteredWaitHandle restituito da questo metodo, chiamare il relativo metodo RegisteredWaitHandle.Unregister per rilasciare i riferimenti all'handle di attesa.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. Si consiglia di chiamare sempre il metodo RegisteredWaitHandle.Unregister, anche se si specifica true per executeOnlyOnce.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. L'operazione di Garbage Collection funziona in modo più efficiente se si chiama il metodo RegisteredWaitHandle.Unregister anziché a seconda del finalizzatore di handle di attesa registrato.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Il metodo RegisterWaitForSingleObject Accoda il delegato specificato al pool di thread.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un thread di lavoro eseguirà il delegato quando si verifica una delle condizioni seguenti:A worker thread will execute the delegate when one of the following occurs:

  • L'oggetto specificato è nello stato segnalato.The specified object is in the signaled state.

  • Intervallo di timeout scaduto.The time-out interval elapses.

Il metodo RegisterWaitForSingleObject controlla lo stato corrente del WaitHandledell'oggetto specificato.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Se lo stato dell'oggetto non è segnalato, il metodo registra un'operazione di attesa.If the object's state is unsignaled, the method registers a wait operation. L'operazione Wait viene eseguita da un thread del pool di thread.The wait operation is performed by a thread from the thread pool. Il delegato viene eseguito da un thread di lavoro quando lo stato dell'oggetto diventa segnalato o scade l'intervallo di timeout.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Se il parametro timeOutInterval non è 0 (zero) e il executeOnlyOnce parametro è false, il timer viene reimpostato ogni volta che l'evento viene segnalato o scade l'intervallo di timeout.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.

Importante

L'uso di un Mutex per waitObject non fornisce l'esclusione reciproca per i callback perché l'API Windows sottostante usa il flag di WT_EXECUTEDEFAULT predefinito, quindi ogni callback viene inviato in un thread del pool di thread separato.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. Anziché una Mutex, utilizzare un Semaphore con un numero massimo di 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Per annullare l'operazione di attesa, chiamare il metodo RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Il thread di attesa utilizza la funzione Win32 WaitForMultipleObjects per monitorare le operazioni di attesa registrate.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Pertanto, se è necessario utilizzare lo stesso handle nativo del sistema operativo in più chiamate a RegisterWaitForSingleObject, è necessario duplicare l'handle utilizzando la funzione 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. Si noti che non è necessario pulsare un oggetto evento passato a RegisterWaitForSingleObject, perché il thread di attesa potrebbe non rilevare che l'evento viene segnalato prima della reimpostazione.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.

Prima di restituire, la funzione modifica lo stato di alcuni tipi di oggetti di sincronizzazione.Before returning, the function modifies the state of some types of synchronization objects. La modifica si verifica solo per l'oggetto il cui stato segnalato ha causato il soddisfacimento della condizione di attesa.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Ad esempio, il conteggio di un semaforo viene ridotto di uno.For example, the count of a semaphore is decreased by one.

Informazioni sulla versioneVersion Information

A partire dalla versione .NET Framework 2,0, il valore della proprietà Thread.CurrentPrincipal viene propagato ai thread di lavoro accodati utilizzando il metodo RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. Nelle versioni precedenti, le informazioni sull'entità non vengono propagate.In earlier versions, the principal information is not propagated.

Vedi anche

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

Registra un delegato per l'attesa di un oggetto WaitHandle, specificando un valore TimeSpan per il timeout.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

Parametri

waitObject
WaitHandle

WaitHandle da registrare.The WaitHandle to register. Usare una classe WaitHandle diversa da Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Delegato WaitOrTimerCallback da chiamare quando il parametro waitObject riceve un segnale.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Oggetto passato al delegato.The object passed to the delegate.

timeout
TimeSpan

Il timeout rappresentato da un valore TimeSpan.The time-out represented by a TimeSpan. Se timeout è pari a 0 (zero), la funzione verifica lo stato dell'oggetto e restituisce immediatamente un valore.If timeout is 0 (zero), the function tests the object's state and returns immediately. Se timeout è -1, l'intervallo di timeout della funzione non termina mai.If timeout is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Viene restituito true per indicare che il thread non attenderà più in base al parametro waitObject dopo la chiamata al delegato; false per indicare che il timer viene reimpostato ogni volta che l'operazione di attesa viene completata fino all'annullamento della registrazione dell'attesa.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.

Restituisce

RegisteredWaitHandle che incapsula l'handle nativo.The RegisteredWaitHandle that encapsulates the native handle.

Eccezioni

Il parametro timeout è minore di -1.The timeout parameter is less than -1.

Il parametro timeout è maggiore di MaxValue.The timeout parameter is greater than MaxValue.

Commenti

Al termine dell'utilizzo del RegisteredWaitHandle restituito da questo metodo, chiamare il relativo metodo RegisteredWaitHandle.Unregister per rilasciare i riferimenti all'handle di attesa.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. Si consiglia di chiamare sempre il metodo RegisteredWaitHandle.Unregister, anche se si specifica true per executeOnlyOnce.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. L'operazione di Garbage Collection funziona in modo più efficiente se si chiama il metodo RegisteredWaitHandle.Unregister anziché a seconda del finalizzatore di handle di attesa registrato.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Il metodo RegisterWaitForSingleObject Accoda il delegato specificato al pool di thread.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un thread di lavoro eseguirà il delegato quando si verifica una delle condizioni seguenti:A worker thread will execute the delegate when one of the following occurs:

  • L'oggetto specificato è nello stato segnalato.The specified object is in the signaled state.

  • Intervallo di timeout scaduto.The time-out interval elapses.

Il metodo RegisterWaitForSingleObject controlla lo stato corrente del WaitHandledell'oggetto specificato.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Se lo stato dell'oggetto non è segnalato, il metodo registra un'operazione di attesa.If the object's state is unsignaled, the method registers a wait operation. L'operazione Wait viene eseguita da un thread del pool di thread.The wait operation is performed by a thread from the thread pool. Il delegato viene eseguito da un thread di lavoro quando lo stato dell'oggetto diventa segnalato o scade l'intervallo di timeout.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Se il parametro timeOutInterval non è 0 (zero) e il executeOnlyOnce parametro è false, il timer viene reimpostato ogni volta che l'evento viene segnalato o scade l'intervallo di timeout.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.

Importante

L'uso di un Mutex per waitObject non fornisce l'esclusione reciproca per i callback perché l'API Windows sottostante usa il flag di WT_EXECUTEDEFAULT predefinito, quindi ogni callback viene inviato in un thread del pool di thread separato.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. Anziché una Mutex, utilizzare un Semaphore con un numero massimo di 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Per annullare l'operazione di attesa, chiamare il metodo RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Il thread di attesa utilizza la funzione Win32 WaitForMultipleObjects per monitorare le operazioni di attesa registrate.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Pertanto, se è necessario utilizzare lo stesso handle nativo del sistema operativo in più chiamate a RegisterWaitForSingleObject, è necessario duplicare l'handle utilizzando la funzione 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. Si noti che non è necessario pulsare un oggetto evento passato a RegisterWaitForSingleObject, perché il thread di attesa potrebbe non rilevare che l'evento viene segnalato prima della reimpostazione.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.

Prima di restituire, la funzione modifica lo stato di alcuni tipi di oggetti di sincronizzazione.Before returning, the function modifies the state of some types of synchronization objects. La modifica si verifica solo per l'oggetto il cui stato segnalato ha causato il soddisfacimento della condizione di attesa.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Ad esempio, il conteggio di un semaforo viene ridotto di uno.For example, the count of a semaphore is decreased by one.

Informazioni sulla versioneVersion Information

A partire dalla versione .NET Framework 2,0, il valore della proprietà Thread.CurrentPrincipal viene propagato ai thread di lavoro accodati utilizzando il metodo RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. Nelle versioni precedenti, le informazioni sull'entità non vengono propagate.In earlier versions, the principal information is not propagated.

Vedi anche

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

Registra un delegato per l'attesa di un oggetto WaitHandle, specificando un valore intero con segno a 32 bit per il timeout in millisecondi.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

Parametri

waitObject
WaitHandle

WaitHandle da registrare.The WaitHandle to register. Usare una classe WaitHandle diversa da Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Delegato WaitOrTimerCallback da chiamare quando il parametro waitObject riceve un segnale.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Oggetto passato al delegato.The object that is passed to the delegate.

millisecondsTimeOutInterval
Int32

Timeout in millisecondi.The time-out in milliseconds. Se il parametro millisecondsTimeOutInterval è pari a 0 (zero), la funzione verifica lo stato dell'oggetto e restituisce immediatamente un valore.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Se millisecondsTimeOutInterval è -1, l'intervallo di timeout della funzione non termina mai.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Viene restituito true per indicare che il thread non attenderà più in base al parametro waitObject dopo la chiamata al delegato; false per indicare che il timer viene reimpostato ogni volta che l'operazione di attesa viene completata fino all'annullamento della registrazione dell'attesa.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.

Restituisce

RegisteredWaitHandle che incapsula l'handle nativo.The RegisteredWaitHandle that encapsulates the native handle.

Eccezioni

Il parametro millisecondsTimeOutInterval è minore di -1.The millisecondsTimeOutInterval parameter is less than -1.

Commenti

Al termine dell'utilizzo del RegisteredWaitHandle restituito da questo metodo, chiamare il relativo metodo RegisteredWaitHandle.Unregister per rilasciare i riferimenti all'handle di attesa.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. Si consiglia di chiamare sempre il metodo RegisteredWaitHandle.Unregister, anche se si specifica true per executeOnlyOnce.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. L'operazione di Garbage Collection funziona in modo più efficiente se si chiama il metodo RegisteredWaitHandle.Unregister anziché a seconda del finalizzatore di handle di attesa registrato.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Il metodo RegisterWaitForSingleObject Accoda il delegato specificato al pool di thread.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un thread di lavoro eseguirà il delegato quando si verifica una delle condizioni seguenti:A worker thread will execute the delegate when one of the following occurs:

  • L'oggetto specificato è nello stato segnalato.The specified object is in the signaled state.

  • Intervallo di timeout scaduto.The time-out interval elapses.

Il metodo RegisterWaitForSingleObject controlla lo stato corrente del WaitHandledell'oggetto specificato.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Se lo stato dell'oggetto non è segnalato, il metodo registra un'operazione di attesa.If the object's state is unsignaled, the method registers a wait operation. L'operazione Wait viene eseguita da un thread del pool di thread.The wait operation is performed by a thread from the thread pool. Il delegato viene eseguito da un thread di lavoro quando lo stato dell'oggetto diventa segnalato o scade l'intervallo di timeout.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Se il parametro timeOutInterval non è 0 (zero) e il executeOnlyOnce parametro è false, il timer viene reimpostato ogni volta che l'evento viene segnalato o scade l'intervallo di timeout.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.

Importante

L'uso di un Mutex per waitObject non fornisce l'esclusione reciproca per i callback perché l'API Windows sottostante usa il flag di WT_EXECUTEDEFAULT predefinito, quindi ogni callback viene inviato in un thread del pool di thread separato.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. Anziché una Mutex, utilizzare un Semaphore con un numero massimo di 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Per annullare l'operazione di attesa, chiamare il metodo RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Il thread di attesa utilizza la funzione Win32 WaitForMultipleObjects per monitorare le operazioni di attesa registrate.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Pertanto, se è necessario utilizzare lo stesso handle nativo del sistema operativo in più chiamate a RegisterWaitForSingleObject, è necessario duplicare l'handle utilizzando la funzione 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. Si noti che non è necessario pulsare un oggetto evento passato a RegisterWaitForSingleObject, perché il thread di attesa potrebbe non rilevare che l'evento viene segnalato prima della reimpostazione.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.

Prima di restituire, la funzione modifica lo stato di alcuni tipi di oggetti di sincronizzazione.Before returning, the function modifies the state of some types of synchronization objects. La modifica si verifica solo per l'oggetto il cui stato segnalato ha causato il soddisfacimento della condizione di attesa.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Ad esempio, il conteggio di un semaforo viene ridotto di uno.For example, the count of a semaphore is decreased by one.

Informazioni sulla versioneVersion Information

A partire dalla versione .NET Framework 2,0, il valore della proprietà Thread.CurrentPrincipal viene propagato ai thread di lavoro accodati utilizzando il metodo RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. Nelle versioni precedenti, le informazioni sull'entità non vengono propagate.In earlier versions, the principal information is not propagated.

Vedi anche

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

Registra un delegato per l'attesa di un oggetto WaitHandle, specificando un valore intero con segno a 64 bit per il timeout in millisecondi.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

Parametri

waitObject
WaitHandle

WaitHandle da registrare.The WaitHandle to register. Usare una classe WaitHandle diversa da Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Delegato WaitOrTimerCallback da chiamare quando il parametro waitObject riceve un segnale.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Oggetto passato al delegato.The object passed to the delegate.

millisecondsTimeOutInterval
Int64

Timeout in millisecondi.The time-out in milliseconds. Se il parametro millisecondsTimeOutInterval è pari a 0 (zero), la funzione verifica lo stato dell'oggetto e restituisce immediatamente un valore.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Se millisecondsTimeOutInterval è -1, l'intervallo di timeout della funzione non termina mai.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

Viene restituito true per indicare che il thread non attenderà più in base al parametro waitObject dopo la chiamata al delegato; false per indicare che il timer viene reimpostato ogni volta che l'operazione di attesa viene completata fino all'annullamento della registrazione dell'attesa.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.

Restituisce

RegisteredWaitHandle che incapsula l'handle nativo.The RegisteredWaitHandle that encapsulates the native handle.

Eccezioni

Il parametro millisecondsTimeOutInterval è minore di -1.The millisecondsTimeOutInterval parameter is less than -1.

Commenti

Al termine dell'utilizzo del RegisteredWaitHandle restituito da questo metodo, chiamare il relativo metodo RegisteredWaitHandle.Unregister per rilasciare i riferimenti all'handle di attesa.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. Si consiglia di chiamare sempre il metodo RegisteredWaitHandle.Unregister, anche se si specifica true per executeOnlyOnce.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. L'operazione di Garbage Collection funziona in modo più efficiente se si chiama il metodo RegisteredWaitHandle.Unregister anziché a seconda del finalizzatore di handle di attesa registrato.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Il metodo RegisterWaitForSingleObject Accoda il delegato specificato al pool di thread.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Un thread di lavoro eseguirà il delegato quando si verifica una delle condizioni seguenti:A worker thread will execute the delegate when one of the following occurs:

  • L'oggetto specificato è nello stato segnalato.The specified object is in the signaled state.

  • Intervallo di timeout scaduto.The time-out interval elapses.

Il metodo RegisterWaitForSingleObject controlla lo stato corrente del WaitHandledell'oggetto specificato.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Se lo stato dell'oggetto non è segnalato, il metodo registra un'operazione di attesa.If the object's state is unsignaled, the method registers a wait operation. L'operazione Wait viene eseguita da un thread del pool di thread.The wait operation is performed by a thread from the thread pool. Il delegato viene eseguito da un thread di lavoro quando lo stato dell'oggetto diventa segnalato o scade l'intervallo di timeout.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Se il parametro timeOutInterval non è 0 (zero) e il executeOnlyOnce parametro è false, il timer viene reimpostato ogni volta che l'evento viene segnalato o scade l'intervallo di timeout.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.

Importante

L'uso di un Mutex per waitObject non fornisce l'esclusione reciproca per i callback perché l'API Windows sottostante usa il flag di WT_EXECUTEDEFAULT predefinito, quindi ogni callback viene inviato in un thread del pool di thread separato.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. Anziché una Mutex, utilizzare un Semaphore con un numero massimo di 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Per annullare l'operazione di attesa, chiamare il metodo RegisteredWaitHandle.Unregister.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Il thread di attesa utilizza la funzione Win32 WaitForMultipleObjects per monitorare le operazioni di attesa registrate.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Pertanto, se è necessario utilizzare lo stesso handle nativo del sistema operativo in più chiamate a RegisterWaitForSingleObject, è necessario duplicare l'handle utilizzando la funzione 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. Si noti che non è necessario pulsare un oggetto evento passato a RegisterWaitForSingleObject, perché il thread di attesa potrebbe non rilevare che l'evento viene segnalato prima della reimpostazione.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.

Prima di restituire, la funzione modifica lo stato di alcuni tipi di oggetti di sincronizzazione.Before returning, the function modifies the state of some types of synchronization objects. La modifica si verifica solo per l'oggetto il cui stato segnalato ha causato il soddisfacimento della condizione di attesa.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Ad esempio, il conteggio di un semaforo viene ridotto di uno.For example, the count of a semaphore is decreased by one.

Informazioni sulla versioneVersion Information

A partire dalla versione .NET Framework 2,0, il valore della proprietà Thread.CurrentPrincipal viene propagato ai thread di lavoro accodati utilizzando il metodo RegisterWaitForSingleObject.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. Nelle versioni precedenti, le informazioni sull'entità non vengono propagate.In earlier versions, the principal information is not propagated.

Vedi anche

Si applica a