This documentation is archived and is not being maintained.

WorkflowQueuingService Class

Provides the services for management of WorkflowQueue objects.

System.Object
  System.Workflow.Runtime.WorkflowQueuingService

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

public class WorkflowQueuingService

The WorkflowQueuingService type exposes the following members.

  NameDescription
Public methodCreateWorkflowQueueCreates a WorkflowQueue by using the specified name and transactional scope.
Public methodDeleteWorkflowQueueDeletes the specified WorkflowQueue.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExistsTests for the existence of the specified WorkflowQueue.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetWorkflowQueueRetrieves the specified WorkflowQueue.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberPendingMessagesPropertyContains the unconsumed items in the workflow queues associated with this WorkflowQueuingService.
Top

WorkflowQueuingService provides methods that you can use to manage the workflow queues associated with a workflow instance.

The following code example demonstrates a method, named CreateQueue, that initializes a WorkflowQueuingService object by calling the ActivityExecutionContext.GetService method. The code then uses the Exists method to determine if a WorkflowQueue with a specified name exists. If it does not exist, the code calls the CreateWorkflowQueue method; if it does the code calls the GetWorkflowQueue method.

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.


private WorkflowQueue CreateQueue(ActivityExecutionContext context)
{
    Console.WriteLine("CreateQueue");
    WorkflowQueuingService qService = context.GetService<WorkflowQueuingService>();

    if (!qService.Exists(this.QueueName))
    {
        qService.CreateWorkflowQueue(this.QueueName, true);
    }

    return qService.GetWorkflowQueue(this.QueueName);
}


.NET Framework

Supported in: 4, 3.5, 3.0

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.

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