AsyncResult Class
Represents the result of an asynchronous operation.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Syntax
public class AsyncResult : EngineObjectRemarks
An AsyncResult represents the result of an asynchronous operation performed by a background thread.
A typical use case in a GUI application looks like this:
The application calls an asynchronous method and saves the returned AsyncResult instance.
The application continues with other work.
At regular intervals, maybe with the help of a timer, the application inspects the State property to determine whether the operation has finished.
If the operation has finished then the application can retrieve the result by calling GetResult.
If the operation has not finished the application can continue with other work or and check again later or, if it no longer wants to wait for a result, call Abort to stop the operation.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
AsyncResult
Platforms
Windows, Linux, Android
See Also
Reference
Core Module
DataSet.GetDataSetInfoAsync
DataSetInfo.FromDirectoryAsync
DataSetInfo.FromFileAsync
AsyncResult Members
The AsyncResult type has the following members.
Properties
| Name | Description |
|---|---|
| IsDisposed | Gets a value that tells whether the current AsyncResult has been disposed. Inherited from EngineObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current AsyncResult represents. Inherited from EngineObject |
| State | Determines the state of the asynchronous operation. |
Methods
| Name | Description |
|---|---|
| Abort | Attempts to abort the background thread that is performing the work. |
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
| GetResult | Returns the result of the asynchronous operation. |
| WaitUntilFinished | Waits until the background thread has finished working. |