BMXNET 4.0 Developer API
DataTableFutures are created synchrounously when Async calls are made on a RemoteSession.
A DataTabelFuture is used to manage each async call and has a variety of methods to support
the relativelty long and dynamic lifecycle and an Async call.
Namespace:
IndianHealthService.BMXNet.AdoAssembly: BMXNET40 (in BMXNET40.dll)
Syntax
| C# | Visual Basic | Visual C++ |
public class DataTableFuture
Public Class DataTableFuture
public ref class DataTableFuture
Members
| All Members | Constructors  | Properties  | Methods | Events  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| DataTableFuture()()() | |
| Aborted | |
| Cancel()()() |
Method to cancel the Async call. This does not stop the server-side processing. The Aborted event
will be called immediately.
|
| Equals(Object) | (Inherited from Object.) |
| ErrorException |
Access to any exceptions that occur during Async call.
|
 | Finalize()()() | (Inherited from Object.) |
| FutureTime |
The time the async call returned (the future)
|
| GetHashCode()()() | (Inherited from Object.) |
| GetType()()() | (Inherited from Object.) |
| HasData |
Answer true if the data has been fetched from the server and is ready to be used by the application.
|
| HasReturned |
Answer true if the Async call has completed on the server and that a result is ready.
|
| HasTimedOut |
Answer true if the Async call has timeed-out (a time-based version of Cancel)
|
| InvokedControl | |
| IsAutoFetchEnabled |
If set to true the result will be fetched before the Returned event is called, otherwise
the Returned event will be triggered and the application code needs to call PostFetch() to retrieve
the result. True by default.
|
| MaxWaitTime |
Number of seconds to wait for an async response before returning without a response.
|
| MemberwiseClone()()() | (Inherited from Object.) |
| PostFetch()()() |
If IsAutoFetchEnabled is false, then the results must be fetched synchrounously useding PostFetch().
Call PostFetch() once and check if HasData is true. If not true, there is was error related to the
async call.
|
| PresentTime |
The time the Future was created.
|
| Result |
The result table if any, or null.
|
| ResultAppContext |
The AppContext that the async call was made with
|
| ResultDataSet |
The data set the result data table is in.
|
 | ResultKey | |
| ResultTableName | |
| Returned |
Triggered with the async returns, see DataTableFutureEventArgs to know if there
is a result waiting. It's very common to hook the Returned event after each Async call and
then unhook it when the Returned or Aborted calls return.
|
| ToString()()() | (Inherited from Object.) |
| TriggerAbortedEvent()()() | |
| TriggerReturnedEvent()()() | |
| WaitTime |
How long in milliseconds the Async call took to complete.
|
| WasCancelled |
Answer true if canceled. It's common that a dialog would allow the user to cancel the
Async call and the Dialog that is holding on the the Future will cancel the Future. Cancelling
the Future does not stop the server-side processing but when the server returns nothing will happen.
|
Remarks
Beware that all return communications are not on the UI thread unless an InvokedControl
is specify.
Inheritance Hierarchy
See Also
