WorkflowQueuingService.CreateWorkflowQueue(IComparable, Boolean) Method
Definition
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.
Creates a WorkflowQueue by using the specified name and transactional scope.
public:
System::Workflow::Runtime::WorkflowQueue ^ CreateWorkflowQueue(IComparable ^ queueName, bool transactional);
public System.Workflow.Runtime.WorkflowQueue CreateWorkflowQueue (IComparable queueName, bool transactional);
member this.CreateWorkflowQueue : IComparable * bool -> System.Workflow.Runtime.WorkflowQueue
Public Function CreateWorkflowQueue (queueName As IComparable, transactional As Boolean) As WorkflowQueue
Parameters
- queueName
- IComparable
The name of the queue.
- transactional
- Boolean
A value that specifies whether the WorkflowQueue is visible outside the scope of the current transaction.
Returns
A WorkflowQueue object.
Exceptions
queueName
is a null reference (Nothing
in Visual Basic).
A WorkflowQueue with the name specified by queueName
already exists.
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
Remarks
A WorkflowQueue is created with the specified queueName
. If transactional is true
, the WorkflowQueue is only visible inside the current transaction.