WorkflowInstance.WorkflowInstanceControl Struct
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.
Provides methods for WorkflowInstance derived classes to access the functionality of the workflow runtime.
protected: value class WorkflowInstance::WorkflowInstanceControl
protected struct WorkflowInstance.WorkflowInstanceControl
Protected Structure WorkflowInstance.WorkflowInstanceControl
- Inheritance
Properties
HasPendingTrackingRecords |
Called by the workflow runtime to determine whether this workflow instance has pending tracking records and a tracking participant. |
IsPersistable |
Gets a value that indicates whether the WorkflowInstance is in a state where it can be persisted. |
State |
Gets the state of the WorkflowInstance. |
TrackingEnabled |
Called by the workflow runtime to determine whether tracking is enabled in this workflow instance. |
Methods
Abort() |
Aborts the WorkflowInstance. |
Abort(Exception) |
Aborts the WorkflowInstance using the specified exception. |
BeginFlushTrackingRecords(TimeSpan, AsyncCallback, Object) |
Called by the workflow runtime to begin sending pending tracking records to tracking participants asynchronously. |
EndFlushTrackingRecords(IAsyncResult) |
Called by the workflow runtime to end the track operation. |
Equals(Object) |
Returns a value that indicates whether the current WorkflowInstance.WorkflowInstanceControl is equal to the specified object. |
FlushTrackingRecords(TimeSpan) |
Called by the workflow runtime to send pending tracking records to tracking participants. |
GetAbortReason() |
Returns the exception that causes the WorkflowInstance to abort. |
GetBookmarks() |
Returns the collection of available bookmarks for the WorkflowInstance. |
GetBookmarks(BookmarkScope) |
Returns the collection of available bookmarks for the WorkflowInstance created in the specified BookmarkScope. |
GetCompletionState() |
Returns the final ActivityInstanceState of the WorkflowInstance. |
GetCompletionState(Exception) |
Returns the final ActivityInstanceState of the WorkflowInstance, including termination exception. |
GetCompletionState(IDictionary<String,Object>, Exception) |
Returns the final ActivityInstanceState of the WorkflowInstance, including workflow outputs and termination exception. |
GetHashCode() |
Returns the hash code for this WorkflowInstance.WorkflowInstanceControl. |
GetMappedVariables() |
Returns a dictionary of variables in the current scope that have been specified with Mapped. |
PauseWhenPersistable() |
Requests that the workflow runtime pause the WorkflowInstance at the next point of execution where it is possible to persist. Note that the scheduler queue may not be empty at this point. |
PrepareForSerialization() |
Prepares the WorkflowInstance state for serialization. |
RequestPause() |
Requests that the scheduler stops. |
Run() |
Instructs the WorkflowInstance to begin execution. |
ScheduleBookmarkResumption(Bookmark, Object) |
Schedules a bookmark resumption with the specified value. |
ScheduleBookmarkResumption(Bookmark, Object, BookmarkScope) |
Schedules a Bookmark resumption from the specified BookmarkScope. |
ScheduleCancel() |
Schedules the cancellation of the WorkflowInstance. |
Terminate(Exception) |
Transitions the WorkflowInstance into the terminal Faulted state using the specified exception. |
Track(WorkflowInstanceRecord) |
Called by the workflow runtime to add the specified pending record to the list of pending records. |
Operators
Equality(WorkflowInstance+WorkflowInstanceControl, WorkflowInstance+WorkflowInstanceControl) |
Returns a value that indicates whether two WorkflowInstance.WorkflowInstanceControl instances are equal. |
Inequality(WorkflowInstance+WorkflowInstanceControl, WorkflowInstance+WorkflowInstanceControl) |
Returns a value that indicates whether two WorkflowInstance.WorkflowInstanceControl instances are not equal. |