MessageQueue.Create Method (String)

 
System_CAPS_noteNote

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

Creates a non-transactional Message Queuing queue at the specified path.

Namespace:   System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

Public Shared Function Create (
	path As String
) As MessageQueue

Parameters

path
Type: System.String

The path of the queue to create.

Return Value

Type: System.Messaging.MessageQueue

A MessageQueue that represents the new queue.

Exception Condition
ArgumentException

The path parameter is null or is an empty string ("").

MessageQueueException

A queue already exists at the specified path.

-or-

An error occurred when accessing a Message Queuing method.

Use this overload to create a non-transactional Message Queuing queue.

To create a new instance of the MessageQueue class in your application and bind it to an existing queue, use the MessageQueue constructor. To create a new queue in Message Queuing, call Create(String).

The syntax for the path parameter depends on the type of queue it references, as shown in the following table.

Queue type

Syntax

Public queue

MachineName\QueueName

Private queue

MachineName\Private$\QueueName

Use "." for the local computer. For more syntax, see the Path property.

The following table shows whether this method is available in various Workgroup modes.

Workgroup mode

Available

Local computer

Yes

Local computer and direct format name

Yes

Remote computer

No

Remote computer and direct format name

No

The following code example creates public and private queues. It sends a message to selected queues.

Imports System
Imports System.Messaging

' Provides a container class for the example.

Public Class MyNewQueue



        ' Provides an entry point into the application.
        '		 
        ' This example creates new public and private 
        ' queues.


        Public Shared Sub Main()

            ' Create a new instance of the class.
            Dim myNewQueue As New MyNewQueue()

            ' Create public and private queues.
            myNewQueue.CreatePublicQueues()
            myNewQueue.CreatePrivateQueues()

            Return

        End Sub 'Main



        ' Creates public queues and sends a message.


        Public Sub CreatePublicQueues()

            ' Create and connect to a public Message Queuing queue.
            If Not MessageQueue.Exists(".\newPublicQueue") Then
                ' Create the queue if it does not exist.
                Dim myNewPublicQueue As MessageQueue = _
                    MessageQueue.Create(".\newPublicQueue")

                ' Send a message to the queue.
                myNewPublicQueue.Send("My message data.")
            End If

            ' Create (but do not connect to) a second public queue.
            If Not MessageQueue.Exists(".\newPublicResponseQueue") _
                Then

                MessageQueue.Create(".\newPublicResponseQueue")
            End If

            Return

        End Sub 'CreatePublicQueues



        ' Creates private queues and sends a message.


        Public Sub CreatePrivateQueues()

            ' Create and connect to a private Message Queuing queue.
            If Not MessageQueue.Exists(".\Private$\newPrivateQueue") _
                Then

                ' Create the queue if it does not exist.
                Dim myNewPrivateQueue As MessageQueue = _
                    MessageQueue.Create(".\Private$\newPrivateQueue")

                ' Send a message to the queue.
                myNewPrivateQueue.Send("My message data.")
            End If

            ' Create (but do not connect to) a second private queue.
            If Not MessageQueue.Exists(".\Private$\newResponseQueue") _
                Then

                MessageQueue.Create(".\Private$\newResponseQueue")
            End If

            Return

        End Sub 'CreatePrivateQueues

End Class 'MyNewQueue

.NET Framework
Available since 1.1
Return to top
Show: