WorkflowApplication.BeginLoadRunnableInstance Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Initiates the asynchronous process of loading a runnable workflow instance from the InstanceStore.
Overloads
BeginLoadRunnableInstance(TimeSpan, AsyncCallback, Object) |
Initiates an operation to load a runnable workflow instance from the InstanceStore using the specified time-out interval. |
BeginLoadRunnableInstance(AsyncCallback, Object) |
Initiates an operation to load a runnable workflow instance from the InstanceStore. |
Remarks
A runnable instance is an instance for which a timer or instance lock has expired.
BeginLoadRunnableInstance(TimeSpan, AsyncCallback, Object)
Initiates an operation to load a runnable workflow instance from the InstanceStore using the specified time-out interval.
public:
IAsyncResult ^ BeginLoadRunnableInstance(TimeSpan timeout, AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginLoadRunnableInstance (TimeSpan timeout, AsyncCallback callback, object state);
member this.BeginLoadRunnableInstance : TimeSpan * AsyncCallback * obj -> IAsyncResult
Public Function BeginLoadRunnableInstance (timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- timeout
- TimeSpan
The interval in which the load operation must complete before the operation is canceled and a TimeoutException is thrown.
- callback
- AsyncCallback
The method to be called when the operation is complete.
- state
- Object
An optional application-specific object containing information about the asynchronous operation.
Returns
A reference to the asynchronous operation.
Remarks
A runnable instance is an instance for which a timer or instance lock has expired.
To determine if the load operation was successful, call EndLoadRunnableInstance. EndLoadRunnableInstance can be called from inside or outside of the callback
method. If EndLoadRunnableInstance is called before the resume operation completes, it blocks until the resume operation completes. If the load operation does not complete within the specified time-out interval a TimeoutException is thrown from EndLoadRunnableInstance.
This method loads a workflow asynchronously using the IAsyncResult asynchronous design pattern. For more information, see Asynchronous Programming Overview.
Applies to
BeginLoadRunnableInstance(AsyncCallback, Object)
Initiates an operation to load a runnable workflow instance from the InstanceStore.
public:
IAsyncResult ^ BeginLoadRunnableInstance(AsyncCallback ^ callback, System::Object ^ state);
public IAsyncResult BeginLoadRunnableInstance (AsyncCallback callback, object state);
member this.BeginLoadRunnableInstance : AsyncCallback * obj -> IAsyncResult
Public Function BeginLoadRunnableInstance (callback As AsyncCallback, state As Object) As IAsyncResult
Parameters
- callback
- AsyncCallback
The method to be called when the operation is complete.
- state
- Object
An optional application-specific object containing information about the asynchronous operation.
Returns
A reference to the asynchronous operation.
Remarks
A runnable instance is an instance for which a timer or instance lock has expired.
To determine if the load operation was successful, call EndLoadRunnableInstance. EndLoadRunnableInstance can be called from inside or outside of the callback
method. If EndLoadRunnableInstance is called before the resume operation completes, it blocks until the resume operation completes. By default, the resume operation must complete in 30 seconds or else a TimeoutException is thrown from EndLoadRunnableInstance.
This method loads a workflow asynchronously using the IAsyncResult asynchronous design pattern. For more information, see Asynchronous Programming Overview.