Edit

Clear-MSMQQueue

  • Reference
Module:
MSMQ

Purges queues.

Syntax

Clear-MSMQQueue
     -InputObject <MessageQueue[]>
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Clear-MsmqQueue cmdlet purges queues. Specify queues to purge by using MessageQueue objects. This cmdlet returns a MessageQueue object that represents the cleared outgoing queue.

Examples

Example 1

PS C:\>Get-MessageQueue -Name "Order*" | Clear-MessageQueue

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies an array of MessageQueue objects. This cmdlet purges the queues that the MessageQueue objects specify. This parameter accepts pipeline input.

Type:MessageQueue[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False