WorkflowQueuingService.GetWorkflowQueue(IComparable) Method

Reference

Definition

Namespace:: System.Workflow.Runtime

Assembly:: System.Workflow.Runtime.dll

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.

Retrieves the specified WorkflowQueue.

public:
 System::Workflow::Runtime::WorkflowQueue ^ GetWorkflowQueue(IComparable ^ queueName);

public System.Workflow.Runtime.WorkflowQueue GetWorkflowQueue (IComparable queueName);

member this.GetWorkflowQueue : IComparable -> System.Workflow.Runtime.WorkflowQueue

Public Function GetWorkflowQueue (queueName As IComparable) As WorkflowQueue

Parameters

queueName: IComparable

The name of the WorkflowQueue to retrieve.

Returns

WorkflowQueue

A WorkflowQueue object.

Exceptions

ArgumentNullException

queueName is a null reference (Nothing in Visual Basic).

InvalidOperationException

The specified WorkflowQueue was not found.

Examples

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);
}

Private Function CreateQueue(ByVal context As ActivityExecutionContext) As WorkflowQueue
    Console.WriteLine("CreateQueue")
    Dim qService As WorkflowQueuingService = context.GetService(Of WorkflowQueuingService)()

    If Not qService.Exists(Me.queueName) Then
        qService.CreateWorkflowQueue(Me.queueName, True)
    End If

    Return qService.GetWorkflowQueue(Me.QueueName)
End Function

Applies to

Share via