ThreadPool.RegisterWaitForSingleObject Methode

Definition

Registriert einen Delegaten, der auf ein WaitHandle wartet.Registers a delegate that is waiting for a WaitHandle.

Überlädt

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

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 32-Bit-Ganzzahl ohne Vorzeichen angegeben wird.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)

Registriert einen Delegaten, der auf ein WaitHandle wartet, und gibt einen TimeSpan-Wert für das Timeout an.Registers a delegate to wait for a WaitHandle, specifying a TimeSpan value for the time-out.

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

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 32-Bit-Ganzzahl mit Vorzeichen angegeben wird.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)

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 64-Bit-Ganzzahl mit Vorzeichen angegeben wird.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)

Wichtig

Diese API ist nicht CLS-kompatibel.

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 32-Bit-Ganzzahl ohne Vorzeichen angegeben wird.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

Parameter

waitObject
WaitHandle

Die zu registrierende WaitHandle.The WaitHandle to register. Verwenden Sie ein anderes WaitHandle als Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Der WaitOrTimerCallback-Delegat, der aufgerufen werden soll, wenn der waitObject-Parameter signalisiert wird.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Das an den Delegaten übergebene Objekt.The object passed to the delegate.

millisecondsTimeOutInterval
UInt32

Das Timeout in Millisekunden.The time-out in milliseconds. Wenn der millisecondsTimeOutInterval-Parameter 0 (null) ist, prüft die Funktion den Zustand des Objekts und kehrt sofort zurück.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Wenn millisecondsTimeOutInterval den Wert -1 hat, läuft das Timeoutintervall der Funktion nie ab.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

true, um anzugeben, dass der Thread nach dem Aufruf des Delegaten nicht mehr auf den waitObject-Parameter warten soll. false, um anzugeben, dass der Zeitgeber nach jedem Abschluss des Wartevorgangs zurückgesetzt wird, bis die Registrierung des Wartevorgangs aufgehoben wird.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.

Gibt zurück

Das RegisteredWaitHandle, mit dem der registrierte Wartevorgang abgebrochen werden kann.The RegisteredWaitHandle that can be used to cancel the registered wait operation.

Attribute

Ausnahmen

Der millisecondsTimeOutInterval-Parameter ist kleiner als -1.The millisecondsTimeOutInterval parameter is less than -1.

Beispiele

Im folgenden Beispiel wird gezeigt, wie die RegisterWaitForSingleObject-Methode verwendet wird, um eine angegebene Rückruf Methode auszuführen, wenn ein angegebenes Wait-Handle signalisiert wird.The following example shows how to use the RegisterWaitForSingleObject method to execute a specified callback method when a specified wait handle is signaled. In diesem Beispiel ist die Rückruf Methode WaitProc, und das Wait-Handle ist ein AutoResetEvent.In this example, the callback method is WaitProc, and the wait handle is an AutoResetEvent.

Im Beispiel wird eine TaskInfo-Klasse definiert, um die Informationen zu speichern, die bei der Ausführung an den Rückruf übermittelt werden.The example defines a TaskInfo class to hold the information that is passed to the callback when it executes. Im Beispiel wird ein TaskInfo-Objekt erstellt, und es werden Zeichen folgen Daten zugewiesen.The example creates a TaskInfo object and assigns it some string data. Der RegisteredWaitHandle, der von der RegisterWaitForSingleObject-Methode zurückgegeben wird, wird dem Handle-Feld des TaskInfo-Objekts zugewiesen, sodass die Rückruf Methode Zugriff auf das RegisteredWaitHandle hat.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.

Zusätzlich zum Angeben von TaskInfo als Objekt, das an die Rückruf Methode übergeben werden soll, gibt der Aufruf der RegisterWaitForSingleObject-Methode die AutoResetEvent an, auf die der Task wartet, ein WaitOrTimerCallback-Delegat, der die WaitProc-Rückruf Methode darstellt, ein zweites Timeout Intervall. und mehrere Rückrufe.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.

Wenn der Haupt Thread den AutoResetEvent durch Aufrufen seiner Set-Methode signalisiert, wird der WaitOrTimerCallback-Delegat aufgerufen.When the main thread signals the AutoResetEvent by calling its Set method, the WaitOrTimerCallback delegate is invoked. Die WaitProc-Methode testet RegisteredWaitHandle, um zu bestimmen, ob ein Timeout aufgetreten ist.The WaitProc method tests RegisteredWaitHandle to determine whether a time-out occurred. Wenn der Rückruf aufgerufen wurde, weil das Wait-Handle signalisiert wurde, hebt die WaitProc-Methode die Registrierung des RegisteredWaitHandle auf, wobei zusätzliche Rückrufe angehalten werden.If the callback was invoked because the wait handle was signaled, the WaitProc method unregisters the RegisteredWaitHandle, stopping additional callbacks. Im Fall eines Timeouts wartet der Task weiterhin.In the case of a time-out, the task continues to wait. Die WaitProc-Methode wird beendet, indem eine Meldung an die Konsole ausgegeben wird.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

Hinweise

Wenn Sie die RegisteredWaitHandle, die von dieser Methode zurückgegeben wird, nicht mehr benötigen, wenden Sie die RegisteredWaitHandle.Unregister-Methode an, um Verweise auf das Wait-Handle freizugeben.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. Es wird empfohlen, die RegisteredWaitHandle.Unregister-Methode immer aufzurufen, auch wenn Sie true für executeOnlyOnce angeben.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister-Methode anstelle von dem Finalizer des registrierten Wait-Handles aufzurufen.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Die RegisterWaitForSingleObject-Methode fügt den angegebenen Delegaten in die Warteschlange des Thread Pools ein.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Ein Arbeits Thread führt den Delegaten aus, wenn eine der folgenden Aktionen auftritt:A worker thread will execute the delegate when one of the following occurs:

  • Das angegebene-Objekt befindet sich im signalisierten Zustand.The specified object is in the signaled state.

  • Das Timeout Intervall ist abgelaufen.The time-out interval elapses.

Die RegisterWaitForSingleObject-Methode überprüft den aktuellen Status des WaitHandle des angegebenen Objekts.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Wenn der Zustand des Objekts nicht signalisiert ist, registriert die Methode einen Warte Vorgang.If the object's state is unsignaled, the method registers a wait operation. Der Warte Vorgang wird von einem Thread aus dem Thread Pool ausgeführt.The wait operation is performed by a thread from the thread pool. Der Delegat wird von einem Arbeits Thread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeout Intervall abläuft.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Wenn der timeOutInterval-Parameter nicht 0 (null) und der executeOnlyOnce-Parameter false ist, wird der Timer jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeout Intervall abläuft.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.

Wichtig

Die Verwendung eines Mutex für waitObject stellt keinen gegenseitigen Ausschluss für die Rückrufe bereit, da die zugrunde liegende Windows-API das Standard Flag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf in einem separaten Thread Pool Thread gesendet wird.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. Verwenden Sie anstelle eines Mutex einen Semaphore mit einer maximalen Anzahl von 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Rufen Sie die RegisteredWaitHandle.Unregister-Methode auf, um den warte Vorgang abzubrechen.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Der Warte Thread verwendet die Win32-Funktion "WaitForMultipleObjects", um registrierte warte Vorgänge zu überwachen.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Wenn Sie das gleiche systemeigene Betriebssystem Handle in mehreren Aufrufen von RegisterWaitForSingleObject verwenden müssen, müssen Sie daher das Handle mithilfe der Win32-Funktion DuplicateHandle duplizieren.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. Beachten Sie, dass Sie ein Ereignis Objekt, das an RegisterWaitForSingleObject übertragen wird, nicht Pulse sollten, da der Warte Thread möglicherweise nicht erkennt, dass das Ereignis signalisiert wird, bevor es zurückgesetzt wird.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.

Vor der Rückgabe ändert die-Funktion den Zustand einiger Typen von Synchronisierungs Objekten.Before returning, the function modifies the state of some types of synchronization objects. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand bewirkt hat, dass die Warte Bedingung erfüllt ist.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.For example, the count of a semaphore is decreased by one.

VersionsinformationenVersion Information

Beginnend mit der .NET Framework Version 2,0 wird der Thread.CurrentPrincipal-Eigenschafts Wert an Arbeitsthreads weitergegeben, die die RegisterWaitForSingleObject-Methode in der Warteschlange verwenden.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. In früheren Versionen werden die Prinzipal Informationen nicht weitergegeben.In earlier versions, the principal information is not propagated.

Siehe auch

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

Registriert einen Delegaten, der auf ein WaitHandle wartet, und gibt einen TimeSpan-Wert für das Timeout an.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

Parameter

waitObject
WaitHandle

Die zu registrierende WaitHandle.The WaitHandle to register. Verwenden Sie ein anderes WaitHandle als Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Der WaitOrTimerCallback-Delegat, der aufgerufen werden soll, wenn der waitObject-Parameter signalisiert wird.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Das an den Delegaten übergebene Objekt.The object passed to the delegate.

timeout
TimeSpan

Das durch eine TimeSpan dargestellte Timeout.The time-out represented by a TimeSpan. Wenn timeout den Wert 0 (null) hat, prüft die Funktion den Zustand des Objekts und kehrt sofort zurück.If timeout is 0 (zero), the function tests the object's state and returns immediately. Wenn timeout den Wert -1 hat, läuft das Timeoutintervall der Funktion nie ab.If timeout is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

true, um anzugeben, dass der Thread nach dem Aufruf des Delegaten nicht mehr auf den waitObject-Parameter warten soll. false, um anzugeben, dass der Zeitgeber nach jedem Abschluss des Wartevorgangs zurückgesetzt wird, bis die Registrierung des Wartevorgangs aufgehoben wird.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.

Gibt zurück

Das RegisteredWaitHandle, das das systemeigene Handle kapselt.The RegisteredWaitHandle that encapsulates the native handle.

Ausnahmen

Der timeout-Parameter ist kleiner als -1.The timeout parameter is less than -1.

Der timeout-Parameter ist größer als MaxValue.The timeout parameter is greater than MaxValue.

Hinweise

Wenn Sie die RegisteredWaitHandle, die von dieser Methode zurückgegeben wird, nicht mehr benötigen, wenden Sie die RegisteredWaitHandle.Unregister-Methode an, um Verweise auf das Wait-Handle freizugeben.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. Es wird empfohlen, die RegisteredWaitHandle.Unregister-Methode immer aufzurufen, auch wenn Sie true für executeOnlyOnce angeben.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister-Methode anstelle von dem Finalizer des registrierten Wait-Handles aufzurufen.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Die RegisterWaitForSingleObject-Methode fügt den angegebenen Delegaten in die Warteschlange des Thread Pools ein.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Ein Arbeits Thread führt den Delegaten aus, wenn eine der folgenden Aktionen auftritt:A worker thread will execute the delegate when one of the following occurs:

  • Das angegebene-Objekt befindet sich im signalisierten Zustand.The specified object is in the signaled state.

  • Das Timeout Intervall ist abgelaufen.The time-out interval elapses.

Die RegisterWaitForSingleObject-Methode überprüft den aktuellen Status des WaitHandle des angegebenen Objekts.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Wenn der Zustand des Objekts nicht signalisiert ist, registriert die Methode einen Warte Vorgang.If the object's state is unsignaled, the method registers a wait operation. Der Warte Vorgang wird von einem Thread aus dem Thread Pool ausgeführt.The wait operation is performed by a thread from the thread pool. Der Delegat wird von einem Arbeits Thread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeout Intervall abläuft.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Wenn der timeOutInterval-Parameter nicht 0 (null) und der executeOnlyOnce-Parameter false ist, wird der Timer jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeout Intervall abläuft.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.

Wichtig

Die Verwendung eines Mutex für waitObject stellt keinen gegenseitigen Ausschluss für die Rückrufe bereit, da die zugrunde liegende Windows-API das Standard Flag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf in einem separaten Thread Pool Thread gesendet wird.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. Verwenden Sie anstelle eines Mutex einen Semaphore mit einer maximalen Anzahl von 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Rufen Sie die RegisteredWaitHandle.Unregister-Methode auf, um den warte Vorgang abzubrechen.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Der Warte Thread verwendet die Win32-Funktion "WaitForMultipleObjects", um registrierte warte Vorgänge zu überwachen.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Wenn Sie das gleiche systemeigene Betriebssystem Handle in mehreren Aufrufen von RegisterWaitForSingleObject verwenden müssen, müssen Sie daher das Handle mithilfe der Win32-Funktion DuplicateHandle duplizieren.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. Beachten Sie, dass Sie ein Ereignis Objekt, das an RegisterWaitForSingleObject übertragen wird, nicht Pulse sollten, da der Warte Thread möglicherweise nicht erkennt, dass das Ereignis signalisiert wird, bevor es zurückgesetzt wird.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.

Vor der Rückgabe ändert die-Funktion den Zustand einiger Typen von Synchronisierungs Objekten.Before returning, the function modifies the state of some types of synchronization objects. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand bewirkt hat, dass die Warte Bedingung erfüllt ist.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.For example, the count of a semaphore is decreased by one.

VersionsinformationenVersion Information

Beginnend mit der .NET Framework Version 2,0 wird der Thread.CurrentPrincipal-Eigenschafts Wert an Arbeitsthreads weitergegeben, die die RegisterWaitForSingleObject-Methode in der Warteschlange verwenden.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. In früheren Versionen werden die Prinzipal Informationen nicht weitergegeben.In earlier versions, the principal information is not propagated.

Siehe auch

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

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 32-Bit-Ganzzahl mit Vorzeichen angegeben wird.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

Parameter

waitObject
WaitHandle

Die zu registrierende WaitHandle.The WaitHandle to register. Verwenden Sie ein anderes WaitHandle als Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Der WaitOrTimerCallback-Delegat, der aufgerufen werden soll, wenn der waitObject-Parameter signalisiert wird.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Das an den Delegaten übergebene Objekt.The object that is passed to the delegate.

millisecondsTimeOutInterval
Int32

Das Timeout in Millisekunden.The time-out in milliseconds. Wenn der millisecondsTimeOutInterval-Parameter 0 (null) ist, prüft die Funktion den Zustand des Objekts und kehrt sofort zurück.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Wenn millisecondsTimeOutInterval den Wert -1 hat, läuft das Timeoutintervall der Funktion nie ab.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

true, um anzugeben, dass der Thread nach dem Aufruf des Delegaten nicht mehr auf den waitObject-Parameter warten soll. false, um anzugeben, dass der Zeitgeber nach jedem Abschluss des Wartevorgangs zurückgesetzt wird, bis die Registrierung des Wartevorgangs aufgehoben wird.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.

Gibt zurück

Das RegisteredWaitHandle, das das systemeigene Handle kapselt.The RegisteredWaitHandle that encapsulates the native handle.

Ausnahmen

Der millisecondsTimeOutInterval-Parameter ist kleiner als -1.The millisecondsTimeOutInterval parameter is less than -1.

Hinweise

Wenn Sie die RegisteredWaitHandle, die von dieser Methode zurückgegeben wird, nicht mehr benötigen, wenden Sie die RegisteredWaitHandle.Unregister-Methode an, um Verweise auf das Wait-Handle freizugeben.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. Es wird empfohlen, die RegisteredWaitHandle.Unregister-Methode immer aufzurufen, auch wenn Sie true für executeOnlyOnce angeben.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister-Methode anstelle von dem Finalizer des registrierten Wait-Handles aufzurufen.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Die RegisterWaitForSingleObject-Methode fügt den angegebenen Delegaten in die Warteschlange des Thread Pools ein.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Ein Arbeits Thread führt den Delegaten aus, wenn eine der folgenden Aktionen auftritt:A worker thread will execute the delegate when one of the following occurs:

  • Das angegebene-Objekt befindet sich im signalisierten Zustand.The specified object is in the signaled state.

  • Das Timeout Intervall ist abgelaufen.The time-out interval elapses.

Die RegisterWaitForSingleObject-Methode überprüft den aktuellen Status des WaitHandle des angegebenen Objekts.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Wenn der Zustand des Objekts nicht signalisiert ist, registriert die Methode einen Warte Vorgang.If the object's state is unsignaled, the method registers a wait operation. Der Warte Vorgang wird von einem Thread aus dem Thread Pool ausgeführt.The wait operation is performed by a thread from the thread pool. Der Delegat wird von einem Arbeits Thread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeout Intervall abläuft.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Wenn der timeOutInterval-Parameter nicht 0 (null) und der executeOnlyOnce-Parameter false ist, wird der Timer jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeout Intervall abläuft.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.

Wichtig

Die Verwendung eines Mutex für waitObject stellt keinen gegenseitigen Ausschluss für die Rückrufe bereit, da die zugrunde liegende Windows-API das Standard Flag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf in einem separaten Thread Pool Thread gesendet wird.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. Verwenden Sie anstelle eines Mutex einen Semaphore mit einer maximalen Anzahl von 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Rufen Sie die RegisteredWaitHandle.Unregister-Methode auf, um den warte Vorgang abzubrechen.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Der Warte Thread verwendet die Win32-Funktion "WaitForMultipleObjects", um registrierte warte Vorgänge zu überwachen.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Wenn Sie das gleiche systemeigene Betriebssystem Handle in mehreren Aufrufen von RegisterWaitForSingleObject verwenden müssen, müssen Sie daher das Handle mithilfe der Win32-Funktion DuplicateHandle duplizieren.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. Beachten Sie, dass Sie ein Ereignis Objekt, das an RegisterWaitForSingleObject übertragen wird, nicht Pulse sollten, da der Warte Thread möglicherweise nicht erkennt, dass das Ereignis signalisiert wird, bevor es zurückgesetzt wird.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.

Vor der Rückgabe ändert die-Funktion den Zustand einiger Typen von Synchronisierungs Objekten.Before returning, the function modifies the state of some types of synchronization objects. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand bewirkt hat, dass die Warte Bedingung erfüllt ist.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.For example, the count of a semaphore is decreased by one.

VersionsinformationenVersion Information

Beginnend mit der .NET Framework Version 2,0 wird der Thread.CurrentPrincipal-Eigenschafts Wert an Arbeitsthreads weitergegeben, die die RegisterWaitForSingleObject-Methode in der Warteschlange verwenden.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. In früheren Versionen werden die Prinzipal Informationen nicht weitergegeben.In earlier versions, the principal information is not propagated.

Siehe auch

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

Registriert einen Delegaten, der auf eine WaitHandle-Klasse wartet, wobei für das Timeout in Millisekunden eine 64-Bit-Ganzzahl mit Vorzeichen angegeben wird.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

Parameter

waitObject
WaitHandle

Die zu registrierende WaitHandle.The WaitHandle to register. Verwenden Sie ein anderes WaitHandle als Mutex.Use a WaitHandle other than Mutex.

callBack
WaitOrTimerCallback

Der WaitOrTimerCallback-Delegat, der aufgerufen werden soll, wenn der waitObject-Parameter signalisiert wird.The WaitOrTimerCallback delegate to call when the waitObject parameter is signaled.

state
Object

Das an den Delegaten übergebene Objekt.The object passed to the delegate.

millisecondsTimeOutInterval
Int64

Das Timeout in Millisekunden.The time-out in milliseconds. Wenn der millisecondsTimeOutInterval-Parameter 0 (null) ist, prüft die Funktion den Zustand des Objekts und kehrt sofort zurück.If the millisecondsTimeOutInterval parameter is 0 (zero), the function tests the object's state and returns immediately. Wenn millisecondsTimeOutInterval den Wert -1 hat, läuft das Timeoutintervall der Funktion nie ab.If millisecondsTimeOutInterval is -1, the function's time-out interval never elapses.

executeOnlyOnce
Boolean

true, um anzugeben, dass der Thread nach dem Aufruf des Delegaten nicht mehr auf den waitObject-Parameter warten soll. false, um anzugeben, dass der Zeitgeber nach jedem Abschluss des Wartevorgangs zurückgesetzt wird, bis die Registrierung des Wartevorgangs aufgehoben wird.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.

Gibt zurück

Das RegisteredWaitHandle, das das systemeigene Handle kapselt.The RegisteredWaitHandle that encapsulates the native handle.

Ausnahmen

Der millisecondsTimeOutInterval-Parameter ist kleiner als -1.The millisecondsTimeOutInterval parameter is less than -1.

Hinweise

Wenn Sie die RegisteredWaitHandle, die von dieser Methode zurückgegeben wird, nicht mehr benötigen, wenden Sie die RegisteredWaitHandle.Unregister-Methode an, um Verweise auf das Wait-Handle freizugeben.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. Es wird empfohlen, die RegisteredWaitHandle.Unregister-Methode immer aufzurufen, auch wenn Sie true für executeOnlyOnce angeben.We recommend that you always call the RegisteredWaitHandle.Unregister method, even if you specify true for executeOnlyOnce. Die Garbage Collection funktioniert effizienter, wenn Sie die RegisteredWaitHandle.Unregister-Methode anstelle von dem Finalizer des registrierten Wait-Handles aufzurufen.Garbage collection works more efficiently if you call the RegisteredWaitHandle.Unregister method instead of depending on the registered wait handle's finalizer.

Die RegisterWaitForSingleObject-Methode fügt den angegebenen Delegaten in die Warteschlange des Thread Pools ein.The RegisterWaitForSingleObject method queues the specified delegate to the thread pool. Ein Arbeits Thread führt den Delegaten aus, wenn eine der folgenden Aktionen auftritt:A worker thread will execute the delegate when one of the following occurs:

  • Das angegebene-Objekt befindet sich im signalisierten Zustand.The specified object is in the signaled state.

  • Das Timeout Intervall ist abgelaufen.The time-out interval elapses.

Die RegisterWaitForSingleObject-Methode überprüft den aktuellen Status des WaitHandle des angegebenen Objekts.The RegisterWaitForSingleObject method checks the current state of the specified object's WaitHandle. Wenn der Zustand des Objekts nicht signalisiert ist, registriert die Methode einen Warte Vorgang.If the object's state is unsignaled, the method registers a wait operation. Der Warte Vorgang wird von einem Thread aus dem Thread Pool ausgeführt.The wait operation is performed by a thread from the thread pool. Der Delegat wird von einem Arbeits Thread ausgeführt, wenn der Zustand des Objekts signalisiert wird oder das Timeout Intervall abläuft.The delegate is executed by a worker thread when the object's state becomes signaled or the time-out interval elapses. Wenn der timeOutInterval-Parameter nicht 0 (null) und der executeOnlyOnce-Parameter false ist, wird der Timer jedes Mal zurückgesetzt, wenn das Ereignis signalisiert wird oder das Timeout Intervall abläuft.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.

Wichtig

Die Verwendung eines Mutex für waitObject stellt keinen gegenseitigen Ausschluss für die Rückrufe bereit, da die zugrunde liegende Windows-API das Standard Flag WT_EXECUTEDEFAULT verwendet, sodass jeder Rückruf in einem separaten Thread Pool Thread gesendet wird.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. Verwenden Sie anstelle eines Mutex einen Semaphore mit einer maximalen Anzahl von 1.Instead of a Mutex, use a Semaphore with a maximum count of 1.

Rufen Sie die RegisteredWaitHandle.Unregister-Methode auf, um den warte Vorgang abzubrechen.To cancel the wait operation, call the RegisteredWaitHandle.Unregister method.

Der Warte Thread verwendet die Win32-Funktion "WaitForMultipleObjects", um registrierte warte Vorgänge zu überwachen.The wait thread uses the Win32 WaitForMultipleObjects function to monitor registered wait operations. Wenn Sie das gleiche systemeigene Betriebssystem Handle in mehreren Aufrufen von RegisterWaitForSingleObject verwenden müssen, müssen Sie daher das Handle mithilfe der Win32-Funktion DuplicateHandle duplizieren.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. Beachten Sie, dass Sie ein Ereignis Objekt, das an RegisterWaitForSingleObject übertragen wird, nicht Pulse sollten, da der Warte Thread möglicherweise nicht erkennt, dass das Ereignis signalisiert wird, bevor es zurückgesetzt wird.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.

Vor der Rückgabe ändert die-Funktion den Zustand einiger Typen von Synchronisierungs Objekten.Before returning, the function modifies the state of some types of synchronization objects. Die Änderung erfolgt nur für das Objekt, dessen signalisierter Zustand bewirkt hat, dass die Warte Bedingung erfüllt ist.Modification occurs only for the object whose signaled state caused the wait condition to be satisfied. Beispielsweise wird die Anzahl eines Semaphors um eins verringert.For example, the count of a semaphore is decreased by one.

VersionsinformationenVersion Information

Beginnend mit der .NET Framework Version 2,0 wird der Thread.CurrentPrincipal-Eigenschafts Wert an Arbeitsthreads weitergegeben, die die RegisterWaitForSingleObject-Methode in der Warteschlange verwenden.Starting with the .NET Framework version 2.0, the Thread.CurrentPrincipal property value is propagated to worker threads queued using the RegisterWaitForSingleObject method. In früheren Versionen werden die Prinzipal Informationen nicht weitergegeben.In earlier versions, the principal information is not propagated.

Siehe auch

Gilt für: