WorkflowQueue Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Note: This API is now obsolete.

Represents a workflow queue.

Namespace:   System.Workflow.Runtime
Assembly:  System.Workflow.Runtime (in System.Workflow.Runtime.dll)


[<ObsoleteAttribute("The System.Workflow.* types are deprecated.  Instead, please use the new types from System.Activities.*")>]
type WorkflowQueue = class end


Gets the number of items contained in the WorkflowQueue.


Gets or sets a value that specifies whether the WorkflowQueue is enabled.


Gets the name of the workflow queue.


Gets the queuing service associated with this WorkflowQueue.


Removes and returns the object at the beginning of the WorkflowQueue.


Adds an object to the end of the WorkflowQueue.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns the object at the beginning of the WorkflowQueue without removing it.


Registers a subscriber to the QueueItemArrived event.


Registers a subscriber to the QueueItemAvailable event.

System_CAPS_pubmethodRegisterForQueueItemAvailable(IActivityEventListener<QueueEventArgs>, String)

Registers a subscriber to the QueueItemAvailable event.


Returns a string that represents the current object.(Inherited from Object.)


Unregisters a subscriber to the QueueItemArrived event.


Unregisters a subscriber to the QueueItemAvailable event.


Occurs when an item is delivered on this WorkflowQueue.


Occurs when an item is available on this WorkflowQueue.


This material discusses types and namespaces that are obsolete. For more information, see Deprecated Types in Windows Workflow Foundation 4.5.

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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

System.Workflow.Runtime Namespace
Workflow and Application Communication
File System Watcher Activity

Return to top