WorkflowInstance::GetWorkflowQueueData Method ()
Gets a collection of WorkflowQueueInfo objects that contains the pending items and subscribed activities for the workflow queues associated with this workflow instance.
Assembly: System.Workflow.Runtime (in System.Workflow.Runtime.dll)
Return Value
Type: System.Collections.ObjectModel::ReadOnlyCollection<WorkflowQueueInfo^>^A ReadOnlyCollection<T> of WorkflowQueueInfo objects.
| Exception | Condition |
|---|---|
| InvalidOperationException | The workflow runtime engine is not running. |
GetWorkflowQueueData returns a collection of WorkflowQueueInfo objects, each of which contains information about the state of one of the workflow queues associated with this workflow instance. WorkflowQueueInfo::Items contains the pending items for a WorkflowQueue and WorkflowQueueInfo::SubscribedActivityNames contains a list of the activities that are subscribed for item delivery on a WorkflowQueue.
The following code example demonstrates how you can use the GetWorkflowQueueData method to obtain information about the state of all workflow queues associated with a WorkflowInstance object. When the WorkflowIdled event occurs, the OnWorkflowIdled method defined in this example is called. It determines which workflow is idled using the WorkflowInstance property and then gets a collection of queued items for the workflow instance by calling the GetWorkflowQueueData method. The code iterates over the collection to determine which activity is waiting for the event that idled the workflow. It then sends an exception to the workflow queue using the EnqueueItem method along with the name of the event queue item.
This code example is part of the Canceling a Workflow SDK sample from the Program.cs file. For more information, see Canceling a Workflow.
Available since 3.0
WorkflowInstance Class
System.Workflow.Runtime Namespace
Canceling a Workflow