WorkflowQueue Class
Represents a workflow queue.
Assembly: System.Workflow.Runtime (in System.Workflow.Runtime.dll)
The WorkflowQueue type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Count | Gets the number of items contained in the WorkflowQueue. |
![]() | Enabled | Gets or sets a value that specifies whether the WorkflowQueue is enabled. |
![]() | QueueName | Gets the name of the workflow queue. |
![]() | QueuingService | Gets the queuing service associated with this WorkflowQueue. |
| Name | Description | |
|---|---|---|
![]() | Dequeue | Removes and returns the object at the beginning of the WorkflowQueue. |
![]() | Enqueue | Adds an object to the end of the WorkflowQueue. |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | Peek | Returns the object at the beginning of the WorkflowQueue without removing it. |
![]() | RegisterForQueueItemArrived | Registers a subscriber to the QueueItemArrived event. |
![]() | RegisterForQueueItemAvailable(IActivityEventListener<QueueEventArgs>) | Registers a subscriber to the QueueItemAvailable event. |
![]() | RegisterForQueueItemAvailable(IActivityEventListener<QueueEventArgs>, String) | Registers a subscriber to the QueueItemAvailable event. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | UnregisterForQueueItemArrived | Unregisters a subscriber to the QueueItemArrived event. |
![]() | UnregisterForQueueItemAvailable | Unregisters a subscriber to the QueueItemAvailable event. |
| Name | Description | |
|---|---|---|
![]() | QueueItemArrived | Occurs when an item is delivered on this WorkflowQueue. |
![]() | QueueItemAvailable | Occurs when an item is available on this WorkflowQueue. |
Workflow queues are used to pass messages between a host or host services and activities in a workflow. Any activity can create a WorkflowQueue by calling WorkflowQueuingService::CreateWorkflowQueue, and a host, a service, or another activity can call Enqueue to add an item to that WorkflowQueue. You can subscribe to the QueueItemAvailable event to be notified when an item arrives on the WorkflowQueue. You can use Peek to examine an item at the beginning of the WorkflowQueue and Dequeue to remove an item from the WorkflowQueue. Each WorkflowQueue is associated with a WorkflowQueuingService that you can use to perform other management operations on the WorkflowQueue, such as deleting the queue. QueuingService exposes the WorkflowQueuingService associated with this WorkflowQueue.
The following code example demonstrates how you can create a WorkflowQueue by calling the WorkflowQueuingService::GetWorkflowQueue method. It also uses the Count property to determine whether any messages exist in the current queue. Finally, the code uses the Dequeue method to remove and return the first object in the queue.
This code example is part of the File Watcher Activity SDK Sample from the FileSystemEvent.cs file. For more information, see File System Watcher Activity.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
