MSMQ - Delete Queue

Declaration

<AMMSMQ ACTIVITY="delete" QUEUE="text" REMOTEMACHINE="text" />

Related Topics   

Description

Deletes the specified queue from the directory service (in the case of public queues) or from the local computer (in the case of private queues).

IMPORTANT: MSMQ must be installed on the (local or remote) computer in order for these activities to function properly. MSMQ is bundled with most Microsoft Windows operating systems, however, it is not installed by default. For more details regarding the installation of MSMQ, see MSMQ Installation & Overview.

Practical Usage

Deletes a message queue, usually after completing the desired MSMQ transactions.

Parameters

Queue

Property

Type

Required

Default

Markup

Description

Local computer

        

If enabled, specifies that this activity will be performed on the local computer (enabled by default). This is a visual mode parameter used only during design time, therefore, contains no markup.

Another computer

Text

No

(Empty)

  1. REMOTEMACHINE="CompName"

  2. REMOTEMACHINE="xxx.xxx.xxx.xxx

If enabled, specifies the host name or IP address of the remote computer that this activity will be performed on. When this parameter is enabled, the Local computer parameter is ignored.

Queue path

Text

Yes

(Empty)

QUEUENAME="CompName\QueueName"

The name of the message queue to delete. The message queue name consists of the compute name, an optional PRIVATE$ keyword that indicates whether it is a private queue and the name of the queue.

Public queue example: ComputerName\QueueName

Private queue example: ComputerName\PRIVATE$\QueueName

Description

Error Causes

On Error

Example

NOTE:
  • The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
  • Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.

Description

This sample code delete's the queue "VMWINVX64\private$\myQueue" located on the local machine."

Copy 
<AMMSMQ ACTION="delete" QUEUENAME="VMWINVX64\private$\myQueue" />