IAsyncResult Interface

Represents the status of an asynchronous operation.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

[<ComVisibleAttribute(true)>]
type IAsyncResult =  interface end

The IAsyncResult type exposes the following members.

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryAsyncStateGets a user-defined object that qualifies or contains information about an asynchronous operation.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryAsyncWaitHandleGets a WaitHandle that is used to wait for an asynchronous operation to complete.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryCompletedSynchronouslyGets a value that indicates whether the asynchronous operation completed synchronously.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryIsCompletedGets a value that indicates whether the asynchronous operation has completed.
Top

The IAsyncResult interface is implemented by classes containing methods that can operate asynchronously. It is the return type of methods that initiate an asynchronous operation, such as FileStream.BeginRead, and it is passed to methods that conclude an asynchronous operation, such as FileStream.EndRead. IAsyncResult objects are also passed to methods invoked by AsyncCallback delegates when an asynchronous operation completes.

An object that supports the IAsyncResult interface stores state information for an asynchronous operation and provides a synchronization object to allow threads to be signaled when the operation completes.

NoteNote

The AsyncResult class is the implementation of IAsyncResult that is returned by the BeginInvoke method when you use a delegate to call a method asynchronously.

For a detailed description of how the IAsyncResult interface is used, see the Calling Synchronous Methods Asynchronously topic.

The following example demonstrates how to use the AsyncWaitHandle property to get a 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.

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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft