Gets a WaitHandle that is used to wait for an asynchronous operation to complete.
Assembly: mscorlib (in mscorlib.dll)
The return value allows the client to wait for an asynchronous operation to complete instead of polling IsCompleted until the operation concludes. The return value can be used to perform a WaitOne, WaitAny, or WaitAll operation.
Notes to Implementers:
The object that implements IAsyncResult does not need to create the WaitHandle until the property is read. It is the choice of the IAsyncResult implementer. However, if the implementer creates , it is the responsibility of the implementer to signal the WaitHandle that will terminate the wait at the appropriate time. For example, System.Runtime.Remoting.Messaging.AsyncResult terminates the wait on behalf of the caller when an asynchronously invoked method returns. Once created, should be kept alive until the user calls the method that concludes the asynchronous operation. At that time the object behind can be discarded.
Notes to Callers:
Clients that wait for the operation to complete (as opposed to polling) use this property to obtain a synchronization object to wait on.
When you use the BeginInvoke method of a delegate to call a method asynchronously and obtain a wait handle from the resulting IAsyncResult, we recommend that you close the wait handle as soon as you are finished using it, by calling the WaitHandle.Close method. If you simply release all references to the wait handle, system resources are freed when garbage collection reclaims the wait handle, but garbage collection works more efficiently when disposable objects are explicitly closed or disposed. For more information, see the AsyncResult.AsyncWaitHandle property.
The following example demonstrates how to use the WaitHandle, and how to wait for an asynchronous call on a delegate. The WaitHandle is signaled when the asynchronous call completes, and you can wait for it by calling the WaitOne method.property to get a
The example consists of two classes: the class that contains the method that is called asynchronously, and the class that contains the Main method that makes the call.
For more information and more examples of calling methods asynchronously by using delegates, see Calling Synchronous Methods Asynchronously.
Available since 8
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Available since 8.1